New Release v1.1.1 for OCI Service Broker (#7)

- Minor Document Fixes - Bug Fixes Co-authored-by: Ashokkumar Kannan <[email protected]> Co-authored-by: Jayasheelan Kumar <[email protected]> Co-authored-by: Naman Mehta <[email protected]> Squashed commit of the following: commit 89da905800aed7df3f81078fdf6238fa094dd203 Author: Jayasheelan Kumar <[email protected]> Date: Thu May 23 16:49:03 2019 +0530 Updating version 1.1.1 in docs commit f9324d9bc2a3a738f3805ea66b34792a06de756d Author: Jayasheelan Kumar <[email protected]> Date: Thu May 23 15:42:23 2019 +0530 Bug fixes and Document fixes, Version upgrade to 1.1.1
oracle · May 23, 2019 · 12c76cd · 12c76cd
1 parent e63208f
commit 12c76cd
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,11 @@ 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.1.1]
+
+- Minor Document Fixes
+- Bug Fixes
+
 [1.1.0]
 
 - Adding support for Oracle Streaming Service (OSS)

diff --git a/README.md b/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/v<REPLACE_LATEST_VERSION>/oci-service-broker-<REPLACE_LATEST_VERSION>.tgz
+https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.tgz
 ```
 
 ## Samples

diff --git a/charts/oci-service-broker/Chart.yaml b/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.1.0
+version: 1.1.1
diff --git a/charts/oci-service-broker/docs/installation.md b/charts/oci-service-broker/docs/installation.md
@@ -49,7 +49,7 @@ helm repo add svc-cat https://svc-catalog-charts.storage.googleapis.com
 Install the Kubernetes Service Catalog helm chart:
 
 ```bash
-helm install svc-cat/catalog --set controllerManager.verbosity="4" --timeout 300 --name catalog --version 0.1.34
+helm install svc-cat/catalog --timeout 300 --name catalog
 ```
 
 Please note that the above command will run the Service Catalog using an embedded `etcd` instance. It is not recommended to run the Service Catalog using an embedded etcd instance in production environments, instead a separate etcd cluster should be setup and used by the Service Catalog. The open source [etcd operator project](https://github.com/coreos/etcd-operator) or a commercial offering may be used to setup a production quality etcd cluster.
@@ -69,7 +69,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/v<REPLACE_LATEST_VERSION>/oci-service-broker-<REPLACE_LATEST_VERSION>.tgz
+https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.tgz
 ```
 
 ### OCI credentials
@@ -85,8 +85,8 @@ The secret should have the below Keys and respective values for it:
 | `tenancy` | The OCID of your tenancy |
 | `fingerprint`    | The Fingerprint of your OCI user |
 | `user`    | OCID of the user |
-| `passphrase`    | The passphrase of the private key(if passphrase is set, then set the value to an empty string) |
 | `privatekey`    | The OCI User private key |
+| `passphrase`    | The passphrase of the private key. This is mandatory and if the private key does not have a passphrase, then set the value to an empty string. |
 | `region`    | The region in which the OKE cluster is running. The value should be in OCI region format. Example: us-ashburn-1 |
 
 Run the below command to create Secret by name `ociCredentials`. (Replace values with your user credentials)
@@ -106,6 +106,15 @@ 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
 
+```bash
+ helm install https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.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.
+
  ```bash
  helm install charts/oci-service-broker/.  --name oci-service-broker \
   --set ociCredentials.secretName=ocicredentials \
@@ -190,6 +199,14 @@ 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.
+```bash
+ helm install https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.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.
 
 ```bash
 helm install  charts/oci-service-broker/. --name oci-service-broker \
@@ -225,7 +242,11 @@ Refer [Restrict access to Service Catalog resources using RBAC](security.md#rest
 
 ## Register OCI Service Broker
 
-Sample files for various services are available under [`oci-service-broker/samples`](../samples) directory.
+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.1.1/oci-service-broker-1.1.1.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.
 

diff --git a/charts/oci-service-broker/templates/deployment.yaml b/charts/oci-service-broker/templates/deployment.yaml
@@ -31,6 +31,8 @@ spec:
         release: {{ .Release.Name }}
     spec:
       serviceAccountName: oci-osb
+      securityContext:
+        fsGroup: 999
       containers:
         - name: {{ .Chart.Name }}
           command:
@@ -73,8 +75,6 @@ spec:
            - "{{ printf "%s=%s" $key $val -}}"
   {{- end }}
 {{- end }}
-          securityContext:
-            fsGroup: 999
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:

diff --git a/charts/oci-service-broker/values.yaml b/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.1.0
+  tag:  1.1.1
 
   # The image pull policy
   pullPolicy: Always

diff --git a/oci-service-broker/build.gradle b/oci-service-broker/build.gradle
@@ -30,14 +30,14 @@ 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.1.0'
+version = project.hasProperty('version_num') ? project.getProperty('version_num') : '1.1.1'
 ext.dockerGroup = 'iad.ocir.io/oci-cnp-dev'
 mainClassName = 'com.oracle.oci.osb.Broker'
 
 sourceCompatibility = 10
 
 ext {
-    ociSdkVersion = "1.5.4"
+    ociSdkVersion = "1.5.6"
     jerseyVersion = "2.27"
     hk2Version = "2.5.0-b42"
     hamcrestVersion = "1.3"

diff --git a/oci-service-broker/download_SDK_libs.sh b/oci-service-broker/download_SDK_libs.sh
@@ -9,15 +9,15 @@
 #sdk jars and their dependency jars. The jars are written to libs directory.
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-SDK_VERSION="1.5.4"
+SDK_VERSION="1.5.6"
 TEMP_DIR="/tmp/oci-java-sdk"
 rm -rf ${TEMP_DIR}
 mkdir -p ${TEMP_DIR} 
 mkdir -p ${SCRIPT_DIR}/libs
 echo "Downloading oci-java-sdk version v${SDK_VERSION} and the dependent libraries..."
 curl -sSL https://github.com/oracle/oci-java-sdk/releases/download/v${SDK_VERSION}/oci-java-sdk.zip -o ${TEMP_DIR}/oci-java-sdk.zip
 unzip -qq ${TEMP_DIR}/oci-java-sdk.zip -d ${TEMP_DIR}
-cp ${TEMP_DIR}/lib/oci-java-sdk-full-1.5.4.jar ${SCRIPT_DIR}/libs/
+cp ${TEMP_DIR}/lib/oci-java-sdk-full-1.5.6.jar ${SCRIPT_DIR}/libs/
 cp ${TEMP_DIR}/third-party/lib/*.jar  ${SCRIPT_DIR}/libs/
 rm -rf ${TEMP_DIR}
 echo "oci-java-sdk and the dependent libraries are downloaded to ${SCRIPT_DIR}/libs directory"