New Release v1.3.3 for OCI Service Broker

- Minor Documentation Fixes

Co-authored-by: Ashokkumar Kannan [email protected]
Co-authored-by: Jayasheelan Kumar [email protected]

Author: jayasheelankumar

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+[1.3.3]
+
+- Minor documentation fixes
+
 [1.3.2]
 
 - Minor documentation fixes

README.md

@@ -29,7 +29,7 @@ See the [Documentation](charts/oci-service-broker/README.md#oci-service-broker)
 The OCI Service Broker is packaged as Helm chart for making it easy to install in Kubernetes Clusters. The chart can be downloaded from below URL.
 
 ```
-https://github.com/oracle/oci-service-broker/releases/download/v1.3.2/oci-service-broker-1.3.2.tgz
+https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz
 ```
 
 ## Samples

charts/oci-service-broker/Chart.yaml

@@ -5,4 +5,4 @@
 apiVersion: v1
 description: A Helm chart for installing OCI Service Broker into a Kubernetes cluster
 name: oci-service-broker
-version: 1.3.2
+version: 1.3.3

charts/oci-service-broker/docs/installation.md

@@ -48,6 +48,12 @@ helm repo add svc-cat https://svc-catalog-charts.storage.googleapis.com
 
 Install the Kubernetes Service Catalog helm chart:
 
+Helm 3.x syntax:
+```bash
+helm install catalog svc-cat/catalog
+```
+
+Helm 2.x syntax:
 ```bash
 helm install svc-cat/catalog --timeout 300 --name catalog
 ```
@@ -69,7 +75,7 @@ brew update && brew install kubernetes-service-catalog-client
 The OCI Service Broker is packaged as Helm chart for making it easy to install in Kubernetes. The chart is available at [charts/oci-service-broker](../) directory.
 
 ```plain
-https://github.com/oracle/oci-service-broker/releases/download/v1.3.2/oci-service-broker-1.3.2.tgz
+https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz
 ```
 
 ### OCI credentials
@@ -106,15 +112,33 @@ The value for `ociCredentials.secretName` should contain the name of the Kuberne
 
 For quickly testing out OCI Service Broker, TLS can be disabled and an embedded etcd container can be used. This can be used for quickly setting up the Broker but not recommended in PRODUCTION environments. Please refer to [Recommended Setup](#recommended-setup) for PRODUCTION environments
 
+Helm 3.x syntax:
 ```bash
- helm install https://github.com/oracle/oci-service-broker/releases/download/v1.3.2/oci-service-broker-1.3.2.tgz  --name oci-service-broker \
+ helm install oci-service-broker https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz \
+  --set ociCredentials.secretName=ocicredentials \
+  --set storage.etcd.useEmbedded=true \
+  --set tls.enabled=false
+ ```
+
+Helm 2.x syntax:
+```bash
+ helm install https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz  --name oci-service-broker \
   --set ociCredentials.secretName=ocicredentials \
   --set storage.etcd.useEmbedded=true \
   --set tls.enabled=false
  ```
 
 Using Helm install from the charts directory in master branch. Please use below command.
 
+Helm 3.x syntax:
+ ```bash
+ helm install oci-service-broker charts/oci-service-broker/. \
+  --set ociCredentials.secretName=ocicredentials \
+  --set storage.etcd.useEmbedded=true \
+  --set tls.enabled=false
+ ```
+
+Helm 2.x syntax:
  ```bash
  helm install charts/oci-service-broker/.  --name oci-service-broker \
   --set ociCredentials.secretName=ocicredentials \
@@ -199,15 +223,34 @@ Please note that the names in keys i.e. keyStore.password and keyStore must not
 #### Recommended Setup Command
 
 Replace the values of --set arguments with your appropriate values to install the OCI Service Broker. User needs to point docker images either from OCIR or from their repository.
+
+Helm 3.x syntax:
+```bash
+ helm install oci-service-broker https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz \
+  --set ociCredentials.secretName=ocicredentials \
+  --set tls.secretName=certsecret \
+  --set storage.etcd.servers=<comma separated list of etcd servers>
+ ```
+
+Helm 2.x syntax:
 ```bash
- helm install https://github.com/oracle/oci-service-broker/releases/download/v1.3.2/oci-service-broker-1.3.2.tgz  --name oci-service-broker \
+ helm install https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz --name oci-service-broker \
   --set ociCredentials.secretName=ocicredentials \
   --set tls.secretName=certsecret \
   --set storage.etcd.servers=<comma separated list of etcd servers>
  ```
 
 Using Helm install from the charts directory in master branch. Please use below command.
 
+Helm 3.x syntax:
+```bash
+helm install oci-service-broker charts/oci-service-broker/. \
+ --set ociCredentials.secretName=ocicredentials \
+ --set tls.secretName=certsecret \
+ --set storage.etcd.servers=<comma separated list of etcd servers>
+```
+
+Helm 2.x syntax:
 ```bash
 helm install  charts/oci-service-broker/. --name oci-service-broker \
  --set ociCredentials.secretName=ocicredentials \
@@ -245,7 +288,7 @@ Refer [Restrict access to Service Catalog resources using RBAC](security.md#rest
 Sample files for various services are available under [`oci-service-broker/samples`](../samples) directory inside the charts. The below command extracts chart that contains the sample files.
 
 ```bash
-curl https://github.com/oracle/oci-service-broker/releases/download/v1.3.2/oci-service-broker-1.3.2.tgz | tar xz
+curl -LO https://github.com/oracle/oci-service-broker/releases/download/v1.3.3/oci-service-broker-1.3.3.tgz | tar xz
 ```
 
 Create a `ClusterServiceBroker` resource with OCI Service Broker URL to register the broker. Use the below register yaml file after updating the namespace of the OCI Service Broker.
@@ -338,7 +381,7 @@ After successful build, a new docker image will be by name 'oci-service-broker'.
 example: 
 
  ```bash
- helm install charts/oci-service-broker/.  --name oci-service-broker \
+ helm install oci-service-broker charts/oci-service-broker/.  \
   --set image.repository=<image name> --set image.tag=<image tag> \
   ...
   ...

charts/oci-service-broker/docs/troubleshoot.md

@@ -109,7 +109,7 @@ kubectl -n <NAMESPACE_OF_OCI_SERVICE_BROKER> get secret ocicredentials -o yaml
 In the helm install command the secret should have been passed as shown below:
 
  ```bash
- helm install charts/oci-service-broker/.  --name oci-service-broker \
+ helm install oci-service-broker charts/oci-service-broker/. \
   --set ociCredentials.secretName=ocicredentials \
   ...
  ```

charts/oci-service-broker/values.yaml

@@ -14,7 +14,7 @@ image:
   repository: iad.ocir.io/oracle/oci-service-broker
 
   # Tag of the image
-  tag:  1.3.2
+  tag:  1.3.3
 
   # The image pull policy
   pullPolicy: Always

oci-service-broker/build.gradle

@@ -30,7 +30,7 @@ apply plugin: 'maven-publish'
 archivesBaseName = 'oci-service-broker'
 
 // Sometimes, the version has to be overridden from command line
-version = project.hasProperty('version_num') ? project.getProperty('version_num') : '1.3.2'
+version = project.hasProperty('version_num') ? project.getProperty('version_num') : '1.3.3'
 ext.dockerGroup = 'iad.ocir.io/oci-cnp-dev'
 mainClassName = 'com.oracle.oci.osb.Broker'