Skip to content

Commit

Permalink
Merge pull request #550 from redhatrises/ocp_cert_docs
Browse files Browse the repository at this point in the history
docs: update openshift installation docs for new certified operator
  • Loading branch information
redhatrises authored Jun 7, 2024
2 parents 1ddbf8b + 0ffa7d8 commit 7f7d929
Show file tree
Hide file tree
Showing 13 changed files with 31 additions and 49 deletions.
24 changes: 12 additions & 12 deletions docs/deployment/openshift/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Once the Krew plugin is installed:
- Using the krew plugin, install the certified operator
```
oc operator install falcon-operator-rhmp --create-operator-group -n falcon-operator
oc operator install falcon-operator --create-operator-group -n falcon-operator
```
</details>
Expand All @@ -194,16 +194,16 @@ Once the Krew plugin is installed:
- You can view the package manifest by running the following command:
```
oc describe packagemanifests falcon-operator-rhmp -n openshift-marketplace
oc describe packagemanifests falcon-operator -n openshift-certified
```
or to get the package manifest in yaml form:
```
oc get packagemanifests -n openshift-marketplace falcon-operator-rhmp -o yaml
oc get packagemanifests -n openshift-marketplace falcon-operator -o yaml
```
Important information from the package manifest output such as the `defaultChannel`, `catalogSource`, `catalogSourceNamespace`, and `currentCSV` are used to create a `Subscription` Kind in a yaml file (next steps) to have OpenShift install the operator from the cluster's marketplace.
You can now install the official [Red Hat Marketplace certified version of the operator](#installing-the-red-hat-marketplace-operator-from-the-console-operatorhub).
You can now install the official [Red Hat certified version of the operator](#installing-the-red-hat-certified-operator-from-the-console-operatorhub).
#### Installing the Red Hat Marketplace Operator from the Console OperatorHub
#### Installing the Red Hat Certified Operator from the Console OperatorHub
##### Creating an OperatorGroup
- If using a custom namespace or the `falcon-operator` namespace, you will need to create an `OperatorGroup`:
Expand All @@ -222,23 +222,23 @@ Once the Krew plugin is installed:
```
An [example OperatorGroup for you to modify is available](https://raw.githubusercontent.com/CrowdStrike/falcon-operator/main/docs/deployment/openshift/operatorgroup.yaml)
##### Installing the Red Hat Marketplace Operator from the Console OperatorHub
##### Installing the Red Hat Operator from the Console OperatorHub
- Create a subscription `yaml` file to install the official Red Hat Marketplace certified operator (`redhat-marketplace`). In this example, the certified operator will be installed via the `Subscription` Kind:
- Create a subscription `yaml` file to install the official Red Hat certified operator (`certified-operators`). In this example, the certified operator will be installed via the `Subscription` Kind:
```
cat << EOF >> subscription.yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: falcon-operator
spec:
channel: certified-0.8
name: falcon-operator-rhmp
source: redhat-marketplace
channel: certified-1.0
name: falcon-operator
source: certified-operators
sourceNamespace: openshift-marketplace
EOF
```
Replace the `channel` in the above spec to the desired deployment channel e.g. `alpha`, `certified-X` (where X is the version), or `stable`, etc. An [example subscription of the official Red Hat Marketplace certified operator is available](redhat-subscription.yaml) to use and modify as appropriate for your cluster. If a specific operator version is desired, add `startingCSV` with the desired operator version e.g. `startingCSV: falcon-operator.v0.1.2`.
Replace the `channel` in the above spec to the desired deployment channel e.g. `certified-X` (where X is the version), or `stable`, etc. An [example subscription of the official Red Hat certified operator is available](redhat-subscription.yaml) to use and modify as appropriate for your cluster. If a specific operator version is desired, add `startingCSV` with the desired operator version e.g. `startingCSV: falcon-operator.v0.1.2`.
#### Deploy the operator
Expand Down Expand Up @@ -389,7 +389,7 @@ Once the Krew plugin is installed:
1. Using the krew plugin, uninstall the certified operator if it is already installed with
```
oc operator uninstall falcon-operator-rhmp -n falcon-operator -X
oc operator uninstall falcon-operator -n falcon-operator -X
```
</details>
Expand Down
9 changes: 0 additions & 9 deletions docs/deployment/openshift/community-subscription.yaml

This file was deleted.

Binary file modified docs/deployment/openshift/images/ocp-opinstall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/deployment/openshift/images/ocp-opinstall2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/deployment/openshift/images/ocp-optile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/deployment/openshift/redhat-subscription.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: Subscription
metadata:
name: falcon-operator
spec:
channel: certified-0.9
name: falcon-operator-rhmp
source: redhat-marketplace
channel: certified-1.0
name: falcon-operator
source: certified-operators
sourceNamespace: openshift-marketplace
2 changes: 1 addition & 1 deletion docs/install_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ falcon-operator-controller-manager-77d7b44f96-t6jsr 1/2 OOMKilled 2 (45s
To remediate this problem in an OpenShift cluster, increase the memory limit of the operator by adding the desired resource configuration to the Subscription:

```shell
oc edit subscription falcon-operator-rhmp -n falcon-operator
oc edit subscription falcon-operator -n falcon-operator
```

and add/edit the resource configuration to the `spec`. For example:
Expand Down
24 changes: 12 additions & 12 deletions docs/src/deployment/openshift/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Once the Krew plugin is installed:
- Using the krew plugin, install the certified operator
```
oc operator install falcon-operator-rhmp --create-operator-group -n falcon-operator
oc operator install falcon-operator --create-operator-group -n falcon-operator
```
</details>
Expand All @@ -194,16 +194,16 @@ Once the Krew plugin is installed:
- You can view the package manifest by running the following command:
```
oc describe packagemanifests falcon-operator-rhmp -n openshift-marketplace
oc describe packagemanifests falcon-operator -n openshift-certified
```
or to get the package manifest in yaml form:
```
oc get packagemanifests -n openshift-marketplace falcon-operator-rhmp -o yaml
oc get packagemanifests -n openshift-marketplace falcon-operator -o yaml
```
Important information from the package manifest output such as the `defaultChannel`, `catalogSource`, `catalogSourceNamespace`, and `currentCSV` are used to create a `Subscription` Kind in a yaml file (next steps) to have OpenShift install the operator from the cluster's marketplace.
You can now install the official [Red Hat Marketplace certified version of the operator](#installing-the-red-hat-marketplace-operator-from-the-console-operatorhub).
You can now install the official [Red Hat certified version of the operator](#installing-the-red-hat-certified-operator-from-the-console-operatorhub).
#### Installing the Red Hat Marketplace Operator from the Console OperatorHub
#### Installing the Red Hat Certified Operator from the Console OperatorHub
##### Creating an OperatorGroup
- If using a custom namespace or the `falcon-operator` namespace, you will need to create an `OperatorGroup`:
Expand All @@ -222,23 +222,23 @@ Once the Krew plugin is installed:
```
An [example OperatorGroup for you to modify is available](https://raw.githubusercontent.com/CrowdStrike/falcon-operator/main/docs/deployment/openshift/operatorgroup.yaml)
##### Installing the Red Hat Marketplace Operator from the Console OperatorHub
##### Installing the Red Hat Operator from the Console OperatorHub
- Create a subscription `yaml` file to install the official Red Hat Marketplace certified operator (`redhat-marketplace`). In this example, the certified operator will be installed via the `Subscription` Kind:
- Create a subscription `yaml` file to install the official Red Hat certified operator (`certified-operators`). In this example, the certified operator will be installed via the `Subscription` Kind:
```
cat << EOF >> subscription.yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: falcon-operator
spec:
channel: certified-0.8
name: falcon-operator-rhmp
source: redhat-marketplace
channel: certified-1.0
name: falcon-operator
source: certified-operators
sourceNamespace: openshift-marketplace
EOF
```
Replace the `channel` in the above spec to the desired deployment channel e.g. `alpha`, `certified-X` (where X is the version), or `stable`, etc. An [example subscription of the official Red Hat Marketplace certified operator is available](redhat-subscription.yaml) to use and modify as appropriate for your cluster. If a specific operator version is desired, add `startingCSV` with the desired operator version e.g. `startingCSV: falcon-operator.v0.1.2`.
Replace the `channel` in the above spec to the desired deployment channel e.g. `certified-X` (where X is the version), or `stable`, etc. An [example subscription of the official Red Hat certified operator is available](redhat-subscription.yaml) to use and modify as appropriate for your cluster. If a specific operator version is desired, add `startingCSV` with the desired operator version e.g. `startingCSV: falcon-operator.v0.1.2`.
#### Deploy the operator
Expand Down Expand Up @@ -389,7 +389,7 @@ Once the Krew plugin is installed:
1. Using the krew plugin, uninstall the certified operator if it is already installed with
```
oc operator uninstall falcon-operator-rhmp -n falcon-operator -X
oc operator uninstall falcon-operator -n falcon-operator -X
```
</details>
Expand Down
9 changes: 0 additions & 9 deletions docs/src/deployment/openshift/community-subscription.yaml

This file was deleted.

Binary file modified docs/src/deployment/openshift/images/ocp-opinstall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/deployment/openshift/images/ocp-opinstall2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/deployment/openshift/images/ocp-optile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/src/deployment/openshift/redhat-subscription.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: Subscription
metadata:
name: falcon-operator
spec:
channel: certified-0.9
name: falcon-operator-rhmp
source: redhat-marketplace
channel: certified-1.0
name: falcon-operator
source: certified-operators
sourceNamespace: openshift-marketplace

0 comments on commit 7f7d929

Please sign in to comment.