Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
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
2 changes: 1 addition & 1 deletion applications/ansible_setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With {aap-short} jobs, you can automate tasks and integrate with external servic
== Installing {aap-short} Resource Operator

. Log in to your {ocp-short} cluster console.
. Click *OperatorHub* in the console navigation.
. Go to *Ecosystem* > *Software Catalog*.
. Search for and install the _{aap-short} Resource Operator_. *Note:* To submit prehook and posthook `AnsibleJobs`, install {aap} Resource Operator with corresponding version available on the {ocp-short} versions.

You can then create the credential from the _Credentials_ page in the console. Click *Add credential*, or access the page from the navigation. See link:../clusters/credentials/credential_ansible.adoc[Creating a credential for {aap-short}] for credential information.
2 changes: 1 addition & 1 deletion clusters/cluster_lifecycle/ansible_config_cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
You must meet the following prerequisites to run Automation templates on your clusters:

* Install {ocp-short}.
* Install the {aap-short} Resource Operator to connect Ansible jobs to the lifecycle of Git subscriptions. For best results when using the Automation template to launch {aap-short} jobs, the {aap-short} job template should be idempotent when it is run. You can find the {aap-short} Resource Operator in the {ocp-short} _OperatorHub_.
* Install the {aap-short} Resource Operator to connect Ansible jobs to the lifecycle of Git subscriptions. For best results when using the Automation template to launch {aap-short} jobs, the {aap-short} job template should be idempotent when it is run. You can find the {aap-short} Resource Operator in the {ocp-catalog}.
* When installing the {aap-short} Resource Operator, you must select the `*-cluster-scoped` channel and select the _all namespaces_ installation mode.

[#ansible-template-run-cluster-console]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You must meet the following prerequisites to run Automation templates on your cl

* A supported version of {ocp-short}

* Install the {aap-short} Resource Operator to connect {aap-short} jobs to the lifecycle of Git subscriptions. When you use the Automation template to start {aap-short} jobs, ensure that the {aap-short} job template is idempotent when it is run. You can find the {aap-short} Resource Operator in the {ocp-short} _OperatorHub_.
* Install the {aap-short} Resource Operator to connect {aap-short} jobs to the lifecycle of Git subscriptions. When you use the Automation template to start {aap-short} jobs, ensure that the {aap-short} job template is idempotent when it is run. You can find the {aap-short} Resource Operator in the {ocp-catalog}.

[#ansible-hosted-cluster-install]
== Running an {aap-short} job to install a hosted cluster
Expand Down
2 changes: 1 addition & 1 deletion clusters/cluster_lifecycle/import_gui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The following table provides the available options for _import mode_, which spec
| Provide the `kubeconfig` file | Copy and paste the contents of the `kubeconfig` file of the cluster that you are importing. You can specify a Red Hat {aap-short} template to run when the cluster is upgraded.
|===

*Note:* You must have the Red Hat {aap-short} Resource Operator installed from OperatorHub to create and run an {aap-short} job.
*Note:* You must have the Red Hat {aap-short} Resource Operator installed from the {ocp-catalog} to create and run an {aap-short} job.

To configure a cluster API address, see xref:../cluster_lifecycle/import_gui.adoc#import-configuring-cluster-api[Optional: Configuring the cluster API address].

Expand Down
22 changes: 10 additions & 12 deletions clusters/install_upgrade/install_connected.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The {mce-short} is installed with {olm}, which manages the installation, upgrade

- You cannot install {mce-short} on a cluster that has a `ManagedCluster` resource configured in an external cluster. You must remove the `ManagedCluster` resource from the external cluster before you can install {mce-short}.
- For {ocp-short} Dedicated environment, you must have `cluster-admin` permissions. By default `dedicated-admin` role does not have the required permissions to create namespaces in the {ocp-short} Dedicated environment.
- By default, the {mce-short} components are installed on worker nodes of your {ocp-short} cluster without any additional configuration. You can install {mce-short} onto worker nodes by using the {ocp-short} OperatorHub web console interface, or by using the {ocp-short} CLI.
- By default, the {mce-short} components are installed on worker nodes of your {ocp-short} cluster without any additional configuration. You can install {mce-short} onto worker nodes by using the {ocp-catalog} console, or by using the {ocp-short} CLI.

- If you configured your {ocp-short} cluster with infrastructure nodes, you can install {mce-short} onto those infrastructure nodes by using the {ocp-short} CLI with additional resource parameters. See the _Installing multicluster engine on infrastructure nodes_ section for those details.

Expand All @@ -18,15 +18,15 @@ The {mce-short} is installed with {olm}, which manages the installation, upgrade

* <<connect-prerequisites-mce,Prerequisites>>
* <<confirm-ocp-installation-mce,Confirm your {ocp-short} installation>>
* <<installing-from-the-operatorhub-mce,Installing from the OperatorHub web console interface>>
* <<installing-from-the-software-catalog-mce,Installing from the {ocp-catalog} console>>
* <<installing-from-the-cli-mce,Installing from the {ocp-short} CLI>>

[#connect-prerequisites-mce]
== Prerequisites

Before you install {mce-short}, see the following prerequisites:

* Your {ocp-short} cluster must have access to the {mce-short} in the OperatorHub catalog from the console.
* Your {ocp-short} cluster must have access to the {mce-short} in the {ocp-catalog} console.

* You need access to the link:https://catalog.redhat.com/software/containers/search?p=1&application_categories_list=Container%20Platform%20%2F%20Management[catalog.redhat.com].

Expand Down Expand Up @@ -77,23 +77,21 @@ console https reencrypt/Redirect None

You can proceed to install {mce-short}.

[#installing-from-the-operatorhub-mce]
== Installing from the OperatorHub web console interface
[#installing-from-the-software-catalog-mce]
== Installing from the {ocp-catalog} console

**Best practice:** From the _Administrator_ view in your {ocp-short} navigation, install the OperatorHub web console interface that is provided with {ocp-short}.

. Select *Operators* > *OperatorHub* to access the list of available operators, and select _multicluster engine for Kubernetes_ operator.

. Click `Install`.
**Best practice:** From the _Administrator_ view in your {ocp-short} navigation, install the {ocp-catalog} console that is provided with {ocp-short}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Best practice:** From the _Administrator_ view in your {ocp-short} navigation, install the {ocp-catalog} console that is provided with {ocp-short}.
*Best practice:* From the _Administrator_ view in your {ocp-short} navigation, install the {ocp-catalog} console that is provided with {ocp-short}.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is not a change we need to make at the moment. 1. It builds correctly. 2. It's very old processes we brought with us. 3. We have to remove all these for conversion.


. Go to *Ecosystem* > *Software Catalog*.
. Choose the Operator that you want to install.
. On the _Operator Installation_ page, select the options for your installation:

+
* Namespace:

- The {mce-short} engine must be installed in its own namespace, or project.

- By default, the OperatorHub console installation process creates a namespace titled `multicluster-engine`. *Best practice:* Continue to use the `multicluster-engine` namespace if it is available.
- By default, the {ocp-catalog} console installation process creates a namespace titled `multicluster-engine`. *Best practice:* Continue to use the `multicluster-engine` namespace if it is available.

- If there is already a namespace named `multicluster-engine`, select a different namespace.

Expand All @@ -108,7 +106,7 @@ You can proceed to install {mce-short}.
- Select *Manual* to receive a notification when an update is available. If you have concerns about when the updates are applied, this might be best practice for you.

+
*Note:* To upgrade to the next minor release, you must return to the _OperatorHub_ page and select a new channel for the more current release.
*Note:* To upgrade to the next minor release, you must return to the {ocp-catalog} and select a new channel for the more current release.

. Select *Install* to apply your changes and create the operator.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ oc adm -a ${LOCAL_SECRET_JSON} release mirror \

To deploy the operator for {update-service} in your {ocp-short} environment, complete the following steps:

. On your hub cluster, access the {ocp-short} operator hub.
. On your hub cluster, access the {ocp-catalog}.
. Deploy the operator by selecting `{update-service} Operator` and update the default values if needed. The deployment of the operator creates a new project named `openshift-update-service`.
. Wait for the installation of the operator to finish.

Expand Down
6 changes: 2 additions & 4 deletions gitops/gitops_policy_generator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,9 @@ Enable the `policyDefaults.orderManifests` parameter and disable `policyDefaults

* See link:../governance/generate_pol_operator_install.adoc#policy-gen-install-operator[Generating a policy that installs the Compliance Operator].
* See link:../gitops/deploy_gitops.adoc#gitops-deploy-policies[Deploying policies by using GitOps] for more details.
* See link:https://docs.redhat.com/en/documentation/red_hat_openshift_gitops/1.11/html/understanding_openshift_gitops/index[Understanding OpenShift GitOps] and the link:https://cloud.redhat.com/learn/topics/operators[Operator] documentation for more details.
* See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/operators/administrator-tasks#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster[Adding Operators to a cluster - Installing from OperatorHub using the CLI]
* See link:https://docs.redhat.com/en/documentation/red_hat_openshift_gitops/1.18[OpenShift GitOps] and the link:https://cloud.redhat.com/learn/topics/operators[Operator] documentation for more details.
* See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/operators/administrator-tasks#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster[Adding Operators to a cluster].
* See the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/security_and_compliance/compliance-operator[Compliance Operator documentation] for more details.
* See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/operators/administrator-tasks#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[_all namespaces_ installation mode].
* See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/operators/administrator-tasks#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[_namespaced_ installation mode].
* See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/nodes/working-with-containers#nodes-containers-init[Using Init Containers to perform tasks before a pod is deployed].
* See link:https://argoproj.github.io/argo-cd/[Argo CD].

Expand Down
2 changes: 1 addition & 1 deletion global_hub/global_hub_install_disconnected.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ oc secrets link <operator_sa> -n <tenant_namespace> <secret_name> --for=pull
[#global-hub-installing-disconnected-operator]
=== Installing the Global Hub Operator

You can install and subscribe an Operator from OperatorHub using the {ocp} web console. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/operators/administrator-tasks#olm-adding-operators-to-a-cluster[Adding Operators to a cluster] for the procedure. After adding the Operator, you can check the status of the {global-hub} Operator by running the following command:
You can install and subscribe an Operator from the {ocp-catalog}. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/operators/administrator-tasks#olm-adding-operators-to-a-cluster[Adding Operators to a cluster] for the procedure. After adding the Operator, you can check the status of the {global-hub} Operator by running the following command:

[source,bash]
----
Expand Down
2 changes: 1 addition & 1 deletion governance/ansible_grc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

* Install the {aap-short} Resource Operator from the Operator Lifecycle Manager. In the _Update Channel_ section, select `stable-2.x-cluster-scoped`. Select the *All namespaces on the cluster (default)* installation mode.
+
*Note:* Ensure that the {aap-short} job template is idempotent when you run it. If you do not have {aap-short} Resource Operator, you can find it from the {ocp} _OperatorHub_ page.
*Note:* Ensure that the {aap-short} job template is idempotent when you run it. If you do not have {aap-short} Resource Operator, you can find it from the {ocp-catalog}.

For more information about installing and configuring {aap}, see link:../applications/ansible_config.adoc#setting-up-ansible[Setting up Ansible tasks].

Expand Down
4 changes: 2 additions & 2 deletions governance/gatekeeper_operator/config_gk_operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install the {gate} from the {olm} catalog to install Gatekeeper on your cluster.
== Prerequisites

- *Required access*: Cluster administrator.
- Understand how to use the Operator Lifecycle Manager and the OperatorHub by completing the _Adding Operators to a cluster_ and the _Additional resources_ section in the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.18/html/operators/administrator-tasks#olm-adding-operators-to-a-cluster[{ocp-short} documentation].
- Understand how to use the Operator Lifecycle Manager and the {ocp-catalog} by completing the _Adding Operators to a cluster_ and the _Additional resources_ section in the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.18/html/operators/administrator-tasks#olm-adding-operators-to-a-cluster[{ocp-short} documentation].

[#gatekeeper-custom-resource]
== Gatekeeper custom resource sample
Expand Down Expand Up @@ -185,4 +185,4 @@ oc explain gatekeeper.spec.audit.auditFromCache
[#gk-add-resources]
== Additional resources

- For more information, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/audit/#configuring-audit[Configuring Audit] in the Gatekeeper documentation.
- For more information, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/audit/#configuring-audit[Configuring Audit] in the Gatekeeper documentation.
24 changes: 12 additions & 12 deletions install/install_connected.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For full support information, see the link:https://access.redhat.com/articles/71

*Notes:*

- By default, the hub cluster components are installed on worker nodes of your {ocp-short} cluster without any additional configuration. You can install the hub cluster on worker nodes by using the {ocp-short} OperatorHub web console interface, or by using the {ocp-short} command-line interface.
- By default, the hub cluster components are installed on worker nodes of your {ocp-short} cluster without any additional configuration. You can install the hub cluster on worker nodes by using the {ocp-catalog} console, or by using the {ocp-short} command-line interface.

- If you have configured your {ocp-short} cluster with infrastructure nodes, you can install the hub cluster on those infrastructure nodes by using the {ocp-short} command-line interface with additional resource parameters. See the _Installing the {acm-short} hub cluster on infrastructure node_ section for more details.

Expand All @@ -25,15 +25,15 @@ For information on how to configure advanced configurations, see options in the

* <<connect-prerequisites,Prerequisites>>
* <<confirm-ocp-installation,Confirm your {ocp-short} installation>>
* <<installing-from-the-operatorhub,Installing from the OperatorHub web console interface>>
* <<installing-from-the-software-catalog,Installing from the {ocp-catalog} console>>
* <<installing-from-the-cli,Installing from the {ocp-short} CLI>>

[#connect-prerequisites]
== Prerequisites

Before you install {acm-short}, see the following requirements:

* Your {ocp} cluster must have access to the {acm-short} operator in the OperatorHub catalog from the {ocp-short} console.
* Your {ocp} cluster must have access to the {acm-short} operator in the {ocp-catalog} console.

* Ensure that your {ocp-short} cluster is supported by your current {acm-short} version. See the link:https://access.redhat.com/articles/7133095[{acm-short} Support Matrix] for more information about the required {ocp-short} versions for each {acm-short} version.

Expand Down Expand Up @@ -84,25 +84,25 @@ console https reencrypt/Redirect None

You can proceed to install {acm-short} from the console or the CLI.

* <<installing-from-the-operatorhub,Installing from the OperatorHub web console interface>>
* <<installing-from-the-software-catalog,Installing from the Software Catalog console>>
* <<installing-from-the-cli,Installing from the {ocp-short} CLI>>

*Note:* For installing the {acm-short} hub cluster on infrastructure nodes, see the _Installing the {acm-short} hub cluster on infrastructure nodes_ section of this procedure.

[#installing-from-the-operatorhub]
== Installing from the OperatorHub web console interface
[#installing-from-the-software-catalog]
== Installing from the Software Catalog console

*Best practice:* From the _Administrator_ view in your console, install the OperatorHub web console interface that is provided with {ocp-short}.
From the _Administrator_ view in your console, install the console interface that is provided with {ocp-short}.

. Select *Operators* > *OperatorHub* to access the list of available operators, and select _Advanced Cluster Management for Kubernetes_ operator.

. On the _Operator subscription_ page, select the options for your installation:
. Log in to your {ocp-short} cluster console.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will get the install team to look at this, but they confirmed in scrum.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cameronmwall can you review this part?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed all mentions of that, can you review again?

. Go to *Ecosystem* > *Software Catalog*.
. Find the _Advanced Cluster Management for Kubernetes_ operator and choose the options for your installation:

Channel:: The channel that you select corresponds to the release that you are installing. When you select the channel, it installs the identified release, and establishes that the future errata updates within that release are obtained.

Namespace information:: The {acm-short} hub cluster must be installed in its own namespace, or project.

- By default, the OperatorHub console installation process creates a namespace that is titled `open-cluster-management`. *Best practice:* Continue to use the `open-cluster-management` namespace if it is available.
- By default, the {ocp-catalog} console installation process creates a namespace that is titled `open-cluster-management`. *Best practice:* Continue to use the `open-cluster-management` namespace if it is available.

- If there is already a namespace named `open-cluster-management`, choose a different namespace.

Expand All @@ -112,7 +112,7 @@ Approval strategy for updates:: The approval strategy identifies the human inter

- Select *Manual* to receive a notification when an update is available. If you have concerns about when the updates are applied, this might be best practice for you.
+
*Important:* To upgrade to the next minor release, you must return to the _OperatorHub_ page and select a new channel for a more recent release.
*Important:* To upgrade to the next minor release, you must return to the _{ocp-catalog}_ page and select a new channel for a more recent release.

. Select *Install* to apply your changes and create the operator.

Expand Down
Loading