|
1 | | -# OpenShift Clients |
| 1 | +# **IBM Charts** Helm Repository |
2 | 2 |
|
3 | | -The OpenShift client `oc` simplifies working with Kubernetes and OpenShift |
4 | | -clusters, offering a number of advantages over `kubectl` such as easy login, |
5 | | -kube config file management, and access to developer tools. The `kubectl` |
6 | | -binary is included alongside for when strict Kubernetes compliance is necessary. |
| 3 | +## Overview |
7 | 4 |
|
8 | | -To learn more about OpenShift, visit [docs.openshift.com](https://docs.openshift.com) |
9 | | -and select the version of OpenShift you are using. |
| 5 | +The `IBM/charts` git repository provides several [Helm](https://github.com/helm/helm#helm) chart repositories and is organized as follows: |
10 | 6 |
|
11 | | -## Installing the tools |
| 7 | +## Helm 3 |
| 8 | +The `repo/ibm-helm` directory contains packaged Helm chart binaries. Installation of a chart from the ibm-helm repo may require a docker-registry secret containing an entitlement key from [MyIBM Container Software Library](https://myibm.ibm.com/products-services/containerlibrary). See [obtaining your entitlement key](https://www.ibm.com/support/knowledgecenter/SSFC4F_1.3.0/readmes/GA/red_hat_getting_started.html#entitlement) for step by step instructions on retrieving an entitlement key if required. |
12 | 9 |
|
13 | | -After extracting this archive, move the `oc` and `kubectl` binaries |
14 | | -to a location on your PATH such as `/usr/local/bin`. Then run: |
| 10 | +To add the ibm-helm repo to local helm chart repository list run the following command : |
| 11 | +``` |
| 12 | +helm repo add ibm-helm https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm |
| 13 | +``` |
15 | 14 |
|
16 | | - oc login [API_URL] |
| 15 | +To add the ibm-helm repo to a OCP 4.6+ helm chart repository list run the following command : |
| 16 | +``` |
| 17 | +cat <<EOF | kubectl apply -f - |
| 18 | +apiVersion: helm.openshift.io/v1beta1 |
| 19 | +kind: HelmChartRepository |
| 20 | +metadata: |
| 21 | + name: ibm-helm-repo |
| 22 | +spec: |
| 23 | + connectionConfig: |
| 24 | + url: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm |
| 25 | +EOF |
| 26 | +``` |
17 | 27 |
|
18 | | -to start a session against an OpenShift cluster. After login, run `oc` and |
19 | | -`oc help` to learn more about how to get started with OpenShift. |
| 28 | +### Getting Started |
| 29 | +If you are new to Helm 3 on OpenShift Container Platform, information on getting started can be found [here](https://docs.openshift.com/container-platform/4.6/cli_reference/helm_cli/getting-started-with-helm-on-openshift-container-platform.html). |
20 | 30 |
|
21 | | -## License |
22 | 31 |
|
23 | | -OpenShift is licensed under the Apache Public License 2.0. The source code for this |
24 | | -program is [located on github](https://github.com/openshift/origin). |
| 32 | +## Helm 2 |
| 33 | + |
| 34 | +The `stable` directory contains Helm chart source provided by IBM, while the `repo/stable` directory contains the packaged Helm chart binaries. To add the stable repo to local repository list run the following command : |
| 35 | +``` |
| 36 | +helm repo add stable https://raw.githubusercontent.com/IBM/charts/master/repo/stable |
| 37 | +``` |
| 38 | + |
| 39 | +**Note:** [Helm stable and incubator charts have moved locations](https://helm.sh/blog/new-location-stable-incubator-charts) causing older helm clients to fail when adding the IBM stable repo as listed above. If using a helm client older then v2.17, please run `helm init --client-only --stable-repo-url https://charts.helm.sh/stable` first to establish new location. |
| 40 | + |
| 41 | +The entitled directory contains Helm chart source provided by IBM for commercial use, while the repo/entitled directory contains the packaged Helm chart binaries. Installation of a chart from the entitled helm repo requires a docker-registry secret containing an entitlement key from [MyIBM Container Software Library](https://myibm.ibm.com/products-services/containerlibrary). See [installing entitled IBM Software onto IBM Cloud Private](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.2.0/installing/install_entitled_workloads.html) for step by step instructions on obtaining an entitlement key and creating the required secrets. To add the entitled repo to local repository list run the following command : |
| 42 | +``` |
| 43 | +helm repo add entitled https://raw.githubusercontent.com/IBM/charts/master/repo/entitled |
| 44 | +``` |
| 45 | +**Note:** [Helm stable and incubator charts have moved locations](https://helm.sh/blog/new-location-stable-incubator-charts) causing older helm clients to fail when adding the IBM entitled repo as listed above. If using a helm client older then v2.17, please run `helm init --client-only --stable-repo-url https://charts.helm.sh/stable` first to establish new location. |
| 46 | + |
| 47 | + |
| 48 | +The `community` directory contains Helm chart source provided by the wider community, while the `repo/community` directory contains the packaged Helm chart binaries. To add the community repo to local repository list run the following command : |
| 49 | +``` |
| 50 | +helm repo add community https://raw.githubusercontent.com/IBM/charts/master/repo/community |
| 51 | +``` |
| 52 | +**Note:** [Helm stable and incubator charts have moved locations](https://helm.sh/blog/new-location-stable-incubator-charts) causing older helm clients to fail when adding the IBM community repo as listed above. If using a helm client older then v2.17, please run `helm init --client-only --stable-repo-url https://charts.helm.sh/stable` first to establish new location. |
| 53 | + |
| 54 | + |
| 55 | +The repo/stable, repo/entitled, and repo/community directories are Helm repositories, and their index.yaml file is built automatically based on the MASTER branch. As of IBM Cloud Private version 3.2, all three repositories are part of the default configuration of IBM Cloud Private, and as such, all charts in those repository will be displayed by default in the IBM Cloud Private catalog. |
| 56 | + |
| 57 | +### Getting Started |
| 58 | + |
| 59 | +#### IBM Cloud Kubernetes Service |
| 60 | +If you are new to the IBM Cloud Kubernetes Service platform, information on how to deploy can be found in [this tutorial.](https://cloud.ibm.com/docs/containers?topic=containers-getting-started#getting-started) |
| 61 | + |
| 62 | +#### IBM Cloud Private |
| 63 | +If you are new to IBM Cloud Private, information on getting started can be found [here](https://www.ibm.com/support/knowledgecenter/en/SSBS6K_3.2.0/getting_started/overview.html). |
| 64 | + |
| 65 | +_Copyright IBM Corporation 2020. All Rights Reserved._ |
| 66 | + |
0 commit comments