Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Doc edits to readme for tasks and ref section #194

Merged
merged 22 commits into from
Sep 23, 2020
Merged

docs: Doc edits to readme for tasks and ref section #194

Changes from 2 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
a6e20ae
docs: Doc edits to readme for tasks and ref section
Sep 10, 2020
d94ca9f
docs: Add versions
Sep 11, 2020
256ccb6
docs: add asterisk
Sep 11, 2020
8811224
docs: add tip about api version
Sep 11, 2020
21b43fe
Doc edits for the contributors guide (#193)
artberger Sep 14, 2020
309f91f
Add service controller unit tests (#195)
JohnStarich Sep 14, 2020
4b54795
Add coverage badge to README (#196)
JohnStarich Sep 14, 2020
d87df03
Fix installer not handling semvers correctly, fix namespace output fi…
JohnStarich Sep 16, 2020
bca25d6
Fix OLM data & formatting issues (#200)
JohnStarich Sep 18, 2020
0a92cb3
break: Use consistent resource names for v1 (#201)
JohnStarich Sep 18, 2020
c7f0d97
Add new stable channel, new versions will update the stable channel (…
JohnStarich Sep 18, 2020
f681f62
Fix Markdown formatting for Operator Hub (#202)
JohnStarich Sep 19, 2020
3ff174d
Upgrade custom resource types to v1 (#204)
JohnStarich Sep 19, 2020
6e798b8
Set up both tests and main.go in one place + add tests to check missi…
JohnStarich Sep 21, 2020
cecd83a
Fix default namespace fallback (#209)
JohnStarich Sep 22, 2020
a10f63e
Add back max concurrent reconciles environment variable (#210)
JohnStarich Sep 22, 2020
a55a57d
Add tests to ensure an alias service will never issue an API call to …
JohnStarich Sep 22, 2020
cb6608d
Add kubeval for validation of kube yaml in PRs (#214)
JohnStarich Sep 22, 2020
b108fac
Bump memory limit again for higher # of secrets in OpenShift (#216)
JohnStarich Sep 22, 2020
6a3bb78
Merge branch 'master' into adb-doc-review-readme
artberger Sep 23, 2020
3a28a48
docs: moving upgrade section back up
Sep 23, 2020
ad83f38
Merge branch 'adb-doc-review-readme' of github.com:IBM/cloud-operator…
Sep 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ With the IBM Cloud Operator, you can provision and bind [IBM public cloud servic

## Table of content
* [Features](#features)
* [Upgrading the operator](#upgrading-the-operator)
* [Prerequisites](#prerequisites)
* [Setting up the operator](#setting-up-the-operator)
* [Using a service ID](#using-a-service-id)
* [Installing the operator for OpenShift clusters](#installing-the-operator-for-openshift-clusters)
* [Installing the operator for Kubernetes clusters](#installing-the-operator-for-kubernetes-clusters)
* [Uninstalling the operator](#uninstalling-the-operator)
* [Using the IBM Cloud Operator](#using-the-ibm-cloud-operator)
* [Upgrading the operator](#upgrading-the-operator)
* [Using separate IBM Cloud accounts](#using-separate-ibm-cloud-accounts)
* [Using a management namespace](#using-a-management-namespace)
* [Reference documentation](#reference-documentation)
Expand All @@ -44,6 +44,24 @@ With the IBM Cloud Operator, you can provision and bind [IBM public cloud servic
[Back to top](#ibm-cloud-operator)
<!-- SHOW operator hub -->

## Upgrading the operator
To upgrade, you can reinstall the operator through the OperatorHub or the `curl` [installation command](README.md#setting-up-the-operator).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one may need to be careful to distinguish the install processes a bit. Since Operator Hub installs in a very different way than the install script does.


### Upgrading to version 0.3.0 or later
**IMPORTANT NOTICE:** v0.1 and v0.2 used a different naming scheme for secrets and configmaps. Before you update the IBM Cloud Operator, create secret and configmap resources with these names and copy the contents of your previous resources to the new resources. Then, the upgraded operator recognizes and continues to update the resources.

| Previous names (&lt; v0.3) | **Current names (v0.3 or later)** | Description |
|:---------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------------|
| secret-ibm-cloud-operator | **ibmcloud-operator-secret** | Secret with the API key, scoped to the namespace. |
| config-ibm-cloud-operator | **ibmcloud-operator-defaults** | ConfigMap with the default values for new resources. |
| ibm-cloud-operator | **ibmcloud-operator-config** | ConfigMap with the management namespace configuration. |
| ${namespace}-secret-ibm-cloud-operator | **${namespace}-ibmcloud-operator-secret** | Management namespace Secret with the API key for ${namespace}. |
| ${namespace}-config-ibm-cloud-operator | **${namespace}-ibmcloud-operator-defaults** | Management namespace ConfigMap with default values for new resources in ${namespace}. |

<!-- END SHOW operator hub -->
[Back to top](#ibm-cloud-operator)
<!-- SHOW operator hub -->

## Prerequisites

1. Have an [IBM Cloud account](https://cloud.ibm.com/registration).
Expand Down Expand Up @@ -132,7 +150,7 @@ By default, the installation script creates an IBM Cloud API key that impersonat

Before you begin, complete the [prerequisite steps](README.md#prerequisites) to log in to IBM Cloud and your cluster, and optionally set up a [service ID API key](README.md#using-a-service-id).

To install the latest release for OpenShift before install, run the following script:
To configure the latest release for OpenShift before installing via the OperatorHub, run the following script:

* **Latest release**:

Expand Down Expand Up @@ -257,23 +275,6 @@ To use the IBM Cloud Operator, create a service instance and then bind the servi
mybinding Opaque 6 102s
```

<!-- END SHOW operator hub -->
[Back to top](#ibm-cloud-operator)
<!-- SHOW operator hub -->

## Upgrading the operator

### Upgrading to version 0.3.0 or later
**IMPORTANT NOTICE:** v0.1 and v0.2 used a different naming scheme for secrets and configmaps. Before you update the IBM Cloud Operator, create secret and configmap resources with these names and copy the contents of your previous resources to the new resources. Then, the upgraded operator recognizes and continues to update the resources.

| Previous names (&lt; v0.3) | **Current names (v0.3 or later)** | Description |
|:---------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------------|
| secret-ibm-cloud-operator | **ibmcloud-operator-secret** | Secret with the API key, scoped to the namespace. |
| config-ibm-cloud-operator | **ibmcloud-operator-defaults** | ConfigMap with the default values for new resources. |
| ibm-cloud-operator | **ibmcloud-operator-config** | ConfigMap with the management namespace configuration. |
| ${namespace}-secret-ibm-cloud-operator | **${namespace}-ibmcloud-operator-secret** | Management namespace Secret with the API key for ${namespace}. |
| ${namespace}-config-ibm-cloud-operator | **${namespace}-ibmcloud-operator-defaults** | Management namespace ConfigMap with default values for new resources in ${namespace}. |

<!-- END SHOW operator hub -->
[Back to top](#ibm-cloud-operator)

Expand Down