Update cheat-sheets.adoc

Update cheat-sheets.adoc

[[doc-guidelines-cheat-sheets]]
== Cheat Sheets and additional hints

For instructions on how to build your own version of the manual:
https://github.com/OpenNMS/opennms/blob/development/docs/opennms-doc/doc-overview/README.adoc[readme]

The documentation uses the AsciiDoc format. There are a number of guides that will help you to get started with using AsciiDoc:

* http://www.methods.co.nz/asciidoc/[Aciidoc Reference]
* http://www.methods.co.nz/asciidoc/faq.html[AsciiDoc FAQ]
* http://powerman.name/doc/asciidoc[AsciiDoc cheatsheet]
* http://xpt.sourceforge.net/techdocs/nix/tool/asciidoc-syn/ascs01-AsciiDocMarkupSyntaxQuickSummary/single/[AsciiDoc Cheatsheet]

For other resources, to gain familiarity with AsciiDoc, you can visit:

 * http://asciidoctor.org/docs/user-manual[AsciiDoc User Manual]
 * http://asciidoctor.org/docs/install-and-use-asciidoctor-maven-plugin/[AsciiDoc Maven Plugin]
 * https://groups.google.com/forum/?fromgroups#!forum/asciidoc[AsciiDoc discussion list]
 * http://code.google.com/p/asciidoc/issues/list[AsciiDoc issue tracker]
 * https://github.com/oreillymedia/docbook2asciidoc[Docbook to AsciiDoc]
 * http://blog.rainwebs.net/2010/02/25/how-to-create-handsome-pdf-documents-without-frustration/[How to create handsome PDF documents without frustration]

nb. We recommend you use the cheatsheets (they are super useful!).

[[doc-guidelines-cheat-sheets]]
== Cheat Sheets and additional hints

For how to build the manual see:
https://github.com/OpenNMS/opennms/blob/development/docs/opennms-doc/doc-overview/README.adoc[readme]

The documents use the AsciiDoc format, see:

* http://www.methods.co.nz/asciidoc/[Aciidoc Reference]
* http://www.methods.co.nz/asciidoc/faq.html[AsciiDoc FAQ]
* http://powerman.name/doc/asciidoc[AsciiDoc cheatsheet]
* http://xpt.sourceforge.net/techdocs/nix/tool/asciidoc-syn/ascs01-AsciiDocMarkupSyntaxQuickSummary/single/[AsciiDoc Cheatsheet]

Here you can find other resources to get familiar with AsciiDoc, see:

 * http://asciidoctor.org/docs/user-manual[AsciiDoc User Manual]
 * http://asciidoctor.org/docs/install-and-use-asciidoctor-maven-plugin/[AsciiDoc Maven Plugin]
 * https://groups.google.com/forum/?fromgroups#!forum/asciidoc[AsciiDoc discussion list]
 * http://code.google.com/p/asciidoc/issues/list[AsciiDoc issue tracker]
 * https://github.com/oreillymedia/docbook2asciidoc[Docbook to AsciiDoc]
 * http://blog.rainwebs.net/2010/02/25/how-to-create-handsome-pdf-documents-without-frustration/[How to create handsome PDF documents without frustration]

The cheatsheets are really useful!


fix misplaced tag parameter in backup command (#1410)

// This module is included in the following assemblies:
//
// assembly-upgrade.adoc

[id='proc-upgrading-the-cluster-operator-0-10-0-to-0-11-0-{context}']
= Upgrading the Cluster Operator from 0.10.0 to 0.11.0

This procedure will describe how to upgrade a Cluster Operator deployment from version 0.10.0 to version 0.11.0.
The availability of Kafka clusters managed by the Cluster Operator is not affected by the upgrade operation.

.Prerequisites

* An existing version 0.10.0 Cluster Operator deployment to be upgraded.

.Procedure

. Backup the existing Cluster Operator resources.
+
ifdef::Kubernetes[]
On {KubernetesName} use `kubectl get`:
+
----
kubectl get all -l app=strimzi -o yaml > strimzi-backup.yaml
----
+
endif::Kubernetes[]
On {OpenShiftName} use `oc get`:
+
----
oc get all -l app=strimzi -o yaml > strimzi-backup.yaml
----

. Update the Cluster Operator.
You will need to modify the installation files according to the namespace the Cluster Operator is running in.
+
include::frag-cluster-operator-namespace-sed.adoc[]
+
If you modified one or more environment variables in your existing Cluster Operator `Deployment`, edit
`install/cluster-operator/050-Deployment-cluster-operator.yaml` to reflect the changes that you made.

. When you have an updated configuration you can deploy it along with the rest of the install resources.
+
ifdef::Kubernetes[]
On {KubernetesName} use `kubectl apply`:
+
----
kubectl apply -f install/cluster-operator
----
+
endif::Kubernetes[]
On {OpenShiftName} use `oc apply`:
+
----
oc apply -f install/cluster-operator
----
+
Wait for the associated rolling updates to complete.

. Update existing resources to cope with deprecated custom resource properties.
+
* If you have `Kafka` resources that specify `Kafka.spec.topicOperator`, rewrite them to use `Kafka.spec.entityOperator.topicOperator` instead.

// This module is included in the following assemblies:
//
// assembly-upgrade.adoc

[id='proc-upgrading-the-cluster-operator-0-10-0-to-0-11-0-{context}']
= Upgrading the Cluster Operator from 0.10.0 to 0.11.0

This procedure will describe how to upgrade a Cluster Operator deployment from version 0.10.0 to version 0.11.0.
The availability of Kafka clusters managed by the Cluster Operator is not affected by the upgrade operation.

.Prerequisites

* An existing version 0.10.0 Cluster Operator deployment to be upgraded.

.Procedure

. Backup the existing Cluster Operator resources.
+
ifdef::Kubernetes[]
On {KubernetesName} use `kubectl get`:
+
----
kubectl get all -l app=strimzi -o yaml > strimzi-backup.yaml
----
+
endif::Kubernetes[]
On {OpenShiftName} use `oc get`:
+
----
oc get -l all app=strimzi -o yaml > strimzi-backup.yaml
----

. Update the Cluster Operator.
You will need to modify the installation files according to the namespace the Cluster Operator is running in.
+
include::frag-cluster-operator-namespace-sed.adoc[]
+
If you modified one or more environment variables in your existing Cluster Operator `Deployment`, edit
`install/cluster-operator/050-Deployment-cluster-operator.yaml` to reflect the changes that you made.

. When you have an updated configuration you can deploy it along with the rest of the install resources.
+
ifdef::Kubernetes[]
On {KubernetesName} use `kubectl apply`:
+
----
kubectl apply -f install/cluster-operator
----
+
endif::Kubernetes[]
On {OpenShiftName} use `oc apply`:
+
----
oc apply -f install/cluster-operator
----
+
Wait for the associated rolling updates to complete.

. Update existing resources to cope with deprecated custom resource properties.
+
* If you have `Kafka` resources that specify `Kafka.spec.topicOperator`, rewrite them to use `Kafka.spec.entityOperator.topicOperator` instead.