From 6961e69f6a4e612ea237060cee8447f74a259069 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Thu, 17 Aug 2023 00:58:24 +0100 Subject: [PATCH 1/5] Converting the Pattern Operator file to asciidoc and implemeting style and consistency changes --- ...using-validated-pattern-operator-adoc.adoc | 95 +++++++++++++++++++ modules/comm-attributes.adoc | 4 +- 2 files changed, 98 insertions(+), 1 deletion(-) create mode 100644 content/learn/using-validated-pattern-operator-adoc.adoc diff --git a/content/learn/using-validated-pattern-operator-adoc.adoc b/content/learn/using-validated-pattern-operator-adoc.adoc new file mode 100644 index 000000000..2ad4ab08e --- /dev/null +++ b/content/learn/using-validated-pattern-operator-adoc.adoc @@ -0,0 +1,95 @@ +--- +menu: + learn: + parent: Infrastructure +title: Using the Validated Patterns Operator (asciidoc) +aliases: /infrastructure/using-validated-pattern-operator-adoc/ +weight: 40 +--- + +:toc: +:imagesdir: /images +:_content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + += About the {validated-patterns-op} + +You use the {validated-patterns-op} to install and manage {solution-name-upstream}. Use the {hybrid-console-first} to install the {validated-patterns-op}. After installing the Operator, you can create an instance where you can specify the details for your pattern. The {validated-patterns-op} then installs and manages the required assets and artifacts that are required for the pattern. + +//Include Procedure module here +[id="installing-validated-patterns-operator_{context}"] +== Installing the {validated-patterns-op} + +.Prerequisites +Access to an {ocp} cluster using an account with cluster-admin permissions. + +.Procedure + +. Navigate in the {hybrid-console-first} to the *Operators* → *OperatorHub* page. + +. Scroll or type a keyword into the *Filter by keyword* box to find the Operator you want. For example, type `validated patterns` to find the {validated-patterns-op}. + +. Select the Operator to display additional information. ++ +[NOTE] +==== +Choosing a Community Operator warns that Red Hat does not certify Community Operators; you must acknowledge the warning before continuing. +==== + +. Read the information about the Operator and click *Install*. + +. On the *Install Operator* page: + +.. Select an *Update channel* (if more than one is available). + +.. Select a *Version* (if more than one is available). + +.. Select an *Installation mode*: +*** *All namespaces on the cluster (default)* installs the Operator in the default `openshift-operators` namespace to watch and be made available to all namespaces in the cluster. This option is not always available. +*** *A specific namespace on the cluster* allows you to choose a specific, single namespace in which to install the Operator. The Operator will only watch and be made available for use in this single namespace. + +.. Select *Automatic* or *Manual* approval strategy. + +. Click *Install* to make the Operator available to the selected namespaces on this {ocp} cluster. + +.Verification +To confirm that the installation is successful: + +. Navigate to the *Operators* → *Installed Operators* page. + +. Check that the Operator is installed in the selected namespace and its status is `Succeeded`. + +//Include Procedure module here +[id="create-pattern-instance_{context}"] +== Creating a pattern instance + +.Prerequisites +The {validated-patterns-op} is successfully installed in the relevant namespace. + +.Procedure + +. Navigate to the *Operators* → *Installed Operators* page. + +. Click the installed *{validated-patterns-op}*. + +. Under the *Details* tab, in the *Provided APIs* section, in the +*Pattern* box, click *Create Instance* that displays the *Create Pattern* page. + +. On the the *Create Pattern* page, select *Form view* and enter information in the following fields: + +** *Name* - A name for the pattern deployment that is used in the projects that you created. +** *Labels* - Apply any other labels you might need for deploying this pattern. +** *Cluster Group Name* - Select a cluster group name to identify the type of cluster where this pattern is being deployed. For example, if you are deploying the {ie-pattern}, the cluster group name is `datacenter`. If you are deploying the {mcg-pattern}, the cluster group name is `hub`. ++ +To know the cluster group name for the patterns that you want to deploy, check the relevant pattern-specific requirements. +. Expand the *Git Config* section to reveal the options and enter the required information. +.. Change the *Target Repo* URL to your forked repository URL. For example, `+https://github.com/validatedpatterns/+` to `+https://github.com//+` +.. Optional: You might need to change the *Target Revision* if it is marked `stable` or if it has a specific a version number. For example, `v2.1`, it might be `main`, or it might be a new branch that you've created, `my-branch`. +. Ensure that you have made any required changes to your `values-*.yaml` files locally and pushed them to your forked repository on the correct branch or target that you chose in the previous step. +. Click *Create*. + +.Verification + +The {rh-gitops} Operator displays in list of *Installed Operators*. The {rh-gitops} Operator installs the remaining assets and artifacts for this pattern. To view the installation of these assets and artifacts, such as {rh-rhacm-first}, ensure that you switch to *Project:All Projects*. + +For more information about post-installation instructions for a pattern, see its _Getting started_ page. diff --git a/modules/comm-attributes.adoc b/modules/comm-attributes.adoc index 71b493520..1e114fbe7 100644 --- a/modules/comm-attributes.adoc +++ b/modules/comm-attributes.adoc @@ -7,7 +7,7 @@ //:prewrap!: //Solution name //:rh-solution-name: Validated Patterns -:solution-name-upstream: Hybrid Cloud Patterns +:solution-name-upstream: Validated Patterns //:solution-version: Update later when we start using versioned releases //Patterns :aeg-pattern: Ansible Edge GitOps pattern @@ -69,6 +69,8 @@ :insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor] :hybrid-console-first: Red Hat Hybrid Cloud Console :hybrid-console: Hybrid Cloud Console +:hybrid-console-url: https://console.redhat.com/ +:hybrid-console-ocp-url: https://console.redhat.com/openshift //ACM :rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM) :rh-rhacm: RHACM From f84b812f8b4576a0cc4c1f00bbf114434f40b105 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Thu, 31 Aug 2023 12:12:56 +0100 Subject: [PATCH 2/5] Addressed review comments --- content/learn/using-validated-pattern-operator-adoc.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/learn/using-validated-pattern-operator-adoc.adoc b/content/learn/using-validated-pattern-operator-adoc.adoc index 2ad4ab08e..49b9bbc86 100644 --- a/content/learn/using-validated-pattern-operator-adoc.adoc +++ b/content/learn/using-validated-pattern-operator-adoc.adoc @@ -14,14 +14,14 @@ include::modules/comm-attributes.adoc[] = About the {validated-patterns-op} -You use the {validated-patterns-op} to install and manage {solution-name-upstream}. Use the {hybrid-console-first} to install the {validated-patterns-op}. After installing the Operator, you can create an instance where you can specify the details for your pattern. The {validated-patterns-op} then installs and manages the required assets and artifacts that are required for the pattern. +You can use the {validated-patterns-op} to install and manage {solution-name-upstream}. Use the {hybrid-console-first} to install the {validated-patterns-op}. After installing the Operator, you can create an instance where you can specify the details for your pattern. The {validated-patterns-op} then installs and manages the required assets and artifacts that the pattern requires. //Include Procedure module here [id="installing-validated-patterns-operator_{context}"] == Installing the {validated-patterns-op} .Prerequisites -Access to an {ocp} cluster using an account with cluster-admin permissions. +* Access to an {ocp} cluster using an account with cluster-admin permissions. .Procedure From b37292f3c366f335cd1cfc841bd2769e904a0641 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Thu, 31 Aug 2023 12:15:57 +0100 Subject: [PATCH 3/5] Addressed review comments --- content/learn/using-validated-pattern-operator-adoc.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/learn/using-validated-pattern-operator-adoc.adoc b/content/learn/using-validated-pattern-operator-adoc.adoc index 49b9bbc86..4486739fb 100644 --- a/content/learn/using-validated-pattern-operator-adoc.adoc +++ b/content/learn/using-validated-pattern-operator-adoc.adoc @@ -2,7 +2,7 @@ menu: learn: parent: Infrastructure -title: Using the Validated Patterns Operator (asciidoc) +title: Using the Validated Patterns Operator aliases: /infrastructure/using-validated-pattern-operator-adoc/ weight: 40 --- @@ -83,8 +83,8 @@ The {validated-patterns-op} is successfully installed in the relevant namespace. + To know the cluster group name for the patterns that you want to deploy, check the relevant pattern-specific requirements. . Expand the *Git Config* section to reveal the options and enter the required information. -.. Change the *Target Repo* URL to your forked repository URL. For example, `+https://github.com/validatedpatterns/+` to `+https://github.com//+` -.. Optional: You might need to change the *Target Revision* if it is marked `stable` or if it has a specific a version number. For example, `v2.1`, it might be `main`, or it might be a new branch that you've created, `my-branch`. +.. Change the *Target Repo* URL to your forked repository URL. For example, change `+https://github.com/validatedpatterns/+` to `+https://github.com//+` +.. Optional: You might need to change the *Target Revision* field. The default value is `HEAD`. However, you can also provide a value for a branch, tag, or commit that you want to deploy. For example, `v2.1`, `main`, or a branch that you created, `my-branch`. . Ensure that you have made any required changes to your `values-*.yaml` files locally and pushed them to your forked repository on the correct branch or target that you chose in the previous step. . Click *Create*. From 46591134fb214b18c48a078fb69869729dc288f6 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Mon, 4 Sep 2023 22:10:19 +0100 Subject: [PATCH 4/5] removing the .md file and replacing it with the updated .adoc file --- ... => using-validated-pattern-operator.adoc} | 0 .../learn/using-validated-pattern-operator.md | 48 ------------------- 2 files changed, 48 deletions(-) rename content/learn/{using-validated-pattern-operator-adoc.adoc => using-validated-pattern-operator.adoc} (100%) delete mode 100644 content/learn/using-validated-pattern-operator.md diff --git a/content/learn/using-validated-pattern-operator-adoc.adoc b/content/learn/using-validated-pattern-operator.adoc similarity index 100% rename from content/learn/using-validated-pattern-operator-adoc.adoc rename to content/learn/using-validated-pattern-operator.adoc diff --git a/content/learn/using-validated-pattern-operator.md b/content/learn/using-validated-pattern-operator.md deleted file mode 100644 index a3bd9c728..000000000 --- a/content/learn/using-validated-pattern-operator.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -menu: - learn: - parent: Infrastructure -title: Using the Validated Pattern operator -weight: 33 -aliases: /infrastructure/using-validated-pattern-operator/ ---- - -# Using the Validated Pattern Operator - -## Background - -The Validated Pattern Operator was developed in order to take advantage of the automation provided with the validated pattern framework. It allows users to deploy validated patterns using the Red Hat OpenShift console. The idea is to point it at a validated pattern repo and let the operator do the work of deploying OpenShift Gitops and then all the parts and applications required for the pattern. - -## Installing the operator - -In the OpenShift console select Operators on the menu on the left of the console. Then select OperatorHub. - -In the `Filter by keyword` box type the word `validated`. The validated patterns operator will appear. Select it. At this time it is a community operator and is not *officially* supported. A Community Operator information pop-up appears. Click `Continue`. - -[![VP Operator](/images/operator/select-vp-operator.png)](/images/operator/select-vp-operator.png) - -On the following pop-up page select the `Install` button. - -[![Install Operator](/images/operator/install-operator.png)](/images/operator/install-operator.png) - -On the **Install Operator** page leave the defaults and select install. - -[![Install Operator form](/images/operator/install-operator-form.png)](/images/operator/install-operator-form.png) - -[![Installing Operator](/images/operator/installing-operator.png)](/images/operator/installing-operator.png)) - -## Create a pattern instance - -When the operator has completed installation click on `View Operator`. Then select the `Create instance` link and start filling out the Create a Pattern form. -1. Choose a name for the pattern deployment. This name will be used in the projects created. -1. Apply any other labels you may need to this deployment. -1. Choose a cluster group name. This is important because it identifies the type of cluster that this pattern will be deployed on. For example if this is `Industrial Edge` then it should be `datacenter`. If it's `multicloud-gitops` then it should be `hub`. Please check with the validated pattern to figure out which cluster group is right for this pattern. -1. Select the `Git Spec` drop down on the form and change the `Target Repo` URL to your forked repository URL. E.g. From `https://github.com/hybrid-cloud-patterns/pattern-name` to `https://github.com/my-git-user/pattern-name` -1. You may need to change the `Target Revision` sometimes it's marked `stable` or has a specific a version number e.g. `v2.1`, it may simply be `main`, or it might be a new branch you've created, `my-branch`. -1. Make sure to make any necessary changes to your `values-*.yaml` files locally and push them to your forked repo. on the correct branch/target chosen above. For a quick start you shouldn't need to make changes. - -Review the rest of the form fields and check if they require changes. For first time pattern deployments you probably don't need any further changes. Select `Create` and the bottom of the form. The OpenShift GitOps operator should show up in `Installed Operators` momentarily. - -From there OpenShift GitOps will install the rest of the assets and artifacts for this pattern. Make sure to change your project to `All Projects` so you will see the other operators installing. E.g. Advanced Cluster Management (ACM). - -Please follow any other post-install instructions for the pattern on that pattern's `Getting started` page. From 80ef5a3e4808ba503ea8262e6177ef55121ee479 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Mon, 4 Sep 2023 22:24:26 +0100 Subject: [PATCH 5/5] updated the aliases name to drop the -adoc suffix --- content/learn/using-validated-pattern-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/learn/using-validated-pattern-operator.adoc b/content/learn/using-validated-pattern-operator.adoc index 4486739fb..10082dffe 100644 --- a/content/learn/using-validated-pattern-operator.adoc +++ b/content/learn/using-validated-pattern-operator.adoc @@ -3,7 +3,7 @@ menu: learn: parent: Infrastructure title: Using the Validated Patterns Operator -aliases: /infrastructure/using-validated-pattern-operator-adoc/ +aliases: /infrastructure/using-validated-pattern-operator/ weight: 40 ---