|
| 1 | +--- |
| 2 | +menu: |
| 3 | + learn: |
| 4 | + parent: Infrastructure |
| 5 | +title: Using the Validated Patterns Operator |
| 6 | +aliases: /infrastructure/using-validated-pattern-operator/ |
| 7 | +weight: 40 |
| 8 | +--- |
| 9 | + |
| 10 | +:toc: |
| 11 | +:imagesdir: /images |
| 12 | +:_content-type: ASSEMBLY |
| 13 | +include::modules/comm-attributes.adoc[] |
| 14 | + |
| 15 | += About the {validated-patterns-op} |
| 16 | + |
| 17 | +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. |
| 18 | + |
| 19 | +//Include Procedure module here |
| 20 | +[id="installing-validated-patterns-operator_{context}"] |
| 21 | +== Installing the {validated-patterns-op} |
| 22 | + |
| 23 | +.Prerequisites |
| 24 | +* Access to an {ocp} cluster using an account with cluster-admin permissions. |
| 25 | + |
| 26 | +.Procedure |
| 27 | + |
| 28 | +. Navigate in the {hybrid-console-first} to the *Operators* → *OperatorHub* page. |
| 29 | + |
| 30 | +. 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}. |
| 31 | + |
| 32 | +. Select the Operator to display additional information. |
| 33 | ++ |
| 34 | +[NOTE] |
| 35 | +==== |
| 36 | +Choosing a Community Operator warns that Red Hat does not certify Community Operators; you must acknowledge the warning before continuing. |
| 37 | +==== |
| 38 | + |
| 39 | +. Read the information about the Operator and click *Install*. |
| 40 | + |
| 41 | +. On the *Install Operator* page: |
| 42 | + |
| 43 | +.. Select an *Update channel* (if more than one is available). |
| 44 | + |
| 45 | +.. Select a *Version* (if more than one is available). |
| 46 | + |
| 47 | +.. Select an *Installation mode*: |
| 48 | +*** *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. |
| 49 | +*** *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. |
| 50 | + |
| 51 | +.. Select *Automatic* or *Manual* approval strategy. |
| 52 | + |
| 53 | +. Click *Install* to make the Operator available to the selected namespaces on this {ocp} cluster. |
| 54 | + |
| 55 | +.Verification |
| 56 | +To confirm that the installation is successful: |
| 57 | + |
| 58 | +. Navigate to the *Operators* → *Installed Operators* page. |
| 59 | + |
| 60 | +. Check that the Operator is installed in the selected namespace and its status is `Succeeded`. |
| 61 | + |
| 62 | +//Include Procedure module here |
| 63 | +[id="create-pattern-instance_{context}"] |
| 64 | +== Creating a pattern instance |
| 65 | + |
| 66 | +.Prerequisites |
| 67 | +The {validated-patterns-op} is successfully installed in the relevant namespace. |
| 68 | + |
| 69 | +.Procedure |
| 70 | + |
| 71 | +. Navigate to the *Operators* → *Installed Operators* page. |
| 72 | + |
| 73 | +. Click the installed *{validated-patterns-op}*. |
| 74 | + |
| 75 | +. Under the *Details* tab, in the *Provided APIs* section, in the |
| 76 | +*Pattern* box, click *Create Instance* that displays the *Create Pattern* page. |
| 77 | + |
| 78 | +. On the the *Create Pattern* page, select *Form view* and enter information in the following fields: |
| 79 | + |
| 80 | +** *Name* - A name for the pattern deployment that is used in the projects that you created. |
| 81 | +** *Labels* - Apply any other labels you might need for deploying this pattern. |
| 82 | +** *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`. |
| 83 | ++ |
| 84 | +To know the cluster group name for the patterns that you want to deploy, check the relevant pattern-specific requirements. |
| 85 | +. Expand the *Git Config* section to reveal the options and enter the required information. |
| 86 | +.. Change the *Target Repo* URL to your forked repository URL. For example, change `+https://github.com/validatedpatterns/<pattern_name>+` to `+https://github.com/<your-git-username>/<pattern-name>+` |
| 87 | +.. 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`. |
| 88 | +. 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. |
| 89 | +. Click *Create*. |
| 90 | + |
| 91 | +.Verification |
| 92 | + |
| 93 | +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*. |
| 94 | + |
| 95 | +For more information about post-installation instructions for a pattern, see its _Getting started_ page. |
0 commit comments