|
| 1 | + |
| 2 | +# Service Binding Operator Helm Chart |
| 3 | + |
| 4 | +This helm chart defines the Service Binding Operator. This provides an option for users to install service binding operators using helm chart. |
| 5 | + |
| 6 | +The chart installation will result in the creation of three Custom Resource Definitions(CRDs): |
| 7 | +- bindablekinds.binding.operators.coreos.com |
| 8 | +- servicebindings.binding.operators.coreos.com |
| 9 | +- servicebindings.servicebinding.io |
| 10 | + |
| 11 | +The resources required for service binding operator will also be installed. The chart creates a service-binding-operator namespace and installs the required resources in that namespace. |
| 12 | + |
| 13 | +## Introduction |
| 14 | + |
| 15 | +The following are the values that can be customized when the chart is installed: |
| 16 | + |
| 17 | +- image.pullPolicy |
| 18 | +- image.tag |
| 19 | +- is_openshift |
| 20 | + |
| 21 | +The is_openshift value signifies whether installing the operator on openshift or non openshift cluster. The value is set to true for openshift and false for non openshift. |
| 22 | + |
| 23 | +A user can define values for the Tag and PullPolicy. A User can obtain tag from https://github.com/redhat-developer/service-binding-operator/tags to get the desired version of service binding operator. The image tag can be obtained from quay.io/redhat-developer/servicebinding-operator using the tag mentioned above. For example , search quay.io/redhat-developer/servicebinding-operator using 31151ab (release tag of v1.0.1) to obtain image tag 31151ab8. By default the chart points out to the latest version. |
| 24 | + |
| 25 | +## Helm Chart Installation |
| 26 | + |
| 27 | +The helm chart installation involves the following steps: |
| 28 | +- Add the helm chart repository |
| 29 | +- Install the chart |
| 30 | +- Helm test |
| 31 | + |
| 32 | +Note: If service binding operator is not installed through OLM, the operator requires that cert-manager is available on the cluster. It can be installed by: |
| 33 | + |
| 34 | +kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.0/cert-manager.yaml |
| 35 | + |
| 36 | +### Add the helm chart repository |
| 37 | +You need to add our helm repository to your local repository. Name the repository as per your convenience. |
| 38 | + |
| 39 | +``` |
| 40 | +helm repo add service-binding-operator https://redhat-developer.github.io/service-binding-operator-helm-chart/ |
| 41 | +``` |
| 42 | + |
| 43 | +### Install the helm chart |
| 44 | +``` |
| 45 | +helm install service-binding-operator https://redhat-developer.github.io/service-binding-operator-helm-chart/service-binding-operator |
| 46 | +``` |
| 47 | +You can check whether the chart is succesfully installed by running the following command |
| 48 | + |
| 49 | +``` |
| 50 | +kubectl get pods -n service-binding-operator |
| 51 | +
|
| 52 | +``` |
| 53 | + |
| 54 | +### Helm test |
| 55 | + |
| 56 | +In order to test the chart the user is expected to create a secret (specify the namespace if applicable), named my-k-config from his kubeconfig . |
| 57 | + |
| 58 | +NOTE: |
| 59 | +In case you are installing the chart on AWS eks cluster then you need to modify the aws-auth configmap. |
| 60 | +``` |
| 61 | +kubectl edit -n kube-system cm/aws-auth |
| 62 | +``` |
| 63 | +Please add -system:masters to mapRoles and save. |
| 64 | +After editing the config map you need to update the eks kubeconfig |
| 65 | +``` |
| 66 | +aws eks update-kubeconfig --name <cluster-name> |
| 67 | +``` |
| 68 | +Then Continue with the following steps. |
| 69 | + |
| 70 | +``` |
| 71 | +kubectl create secret generic my-k-config --from-file=<PATH to your kubeconfig> |
| 72 | +``` |
| 73 | + |
| 74 | +Run the helm test (specify the namespace if applicable) using : |
| 75 | + |
| 76 | +``` |
| 77 | +helm test service-binding-operator |
| 78 | +``` |
| 79 | + |
| 80 | +Please ensure to delete the secret (specify the namespace if applicable) created : |
| 81 | +``` |
| 82 | +kubectl delete secret my-k-config |
| 83 | +``` |
| 84 | + |
| 85 | +## Additional Help |
| 86 | +Please reach out to us for any additional queries by creating an issue on https://github.com/redhat-developer/service-binding-operator/issues. |
0 commit comments