Skip to content

Commit 81a98dd

Browse files
mburke5678mburke5678
authored
Merge pull request #73583 from jmanthei/OSDOCS-9725
OSDOCS-9725 ALBO Install Doc Procedure Updates
2 parents 79c9af7 + a806573 commit 81a98dd

File tree

3 files changed

+165
-8
lines changed

3 files changed

+165
-8
lines changed

‎modules/installing-aws-load-balancer-operator-cli.adoc

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="nw-installing-aws-load-balancer-operator-cli_{context}"]
7+
= Installing the AWS Load Balancer Operator by using the CLI
8+
9+
You can install the AWS Load Balancer Operator by using the CLI.
10+
11+
.Prerequisites
12+
13+
* You are logged in to the {product-title} web console as a user with `cluster-admin` permissions.
14+
15+
* Your cluster is configured with AWS as the platform type and cloud provider.
16+
17+
* You are logged into the OpenShift CLI (`oc`).
18+
19+
.Procedure
20+
21+
. Create a `Namespace` object:
22+
23+
.. Create a YAML file that defines the `Namespace` object:
24+
+
25+
.Example `namespace.yaml` file
26+
[source,yaml]
27+
----
28+
apiVersion: v1
29+
kind: Namespace
30+
metadata:
31+
name: aws-load-balancer-operator
32+
----
33+
34+
.. Create the `Namespace` object by running the following command:
35+
+
36+
[source,terminal]
37+
----
38+
$ oc apply -f namespace.yaml
39+
----
40+
41+
. Create a `CredentialsRequest` object:
42+
43+
.. Create a YAML file that defines the `CredentialsRequest` object:
44+
+
45+
.Example `credentialsrequest.yaml` file
46+
[source,yaml]
47+
----
48+
apiVersion: cloudcredential.openshift.io/v1
49+
kind: CredentialsRequest
50+
metadata:
51+
name: aws-load-balancer-operator
52+
namespace: openshift-cloud-credential-operator
53+
spec:
54+
providerSpec:
55+
apiVersion: cloudcredential.openshift.io/v1
56+
kind: AWSProviderSpec
57+
statementEntries:
58+
- action:
59+
- ec2:DescribeSubnets
60+
effect: Allow
61+
resource: "*"
62+
- action:
63+
- ec2:CreateTags
64+
- ec2:DeleteTags
65+
effect: Allow
66+
resource: arn:aws:ec2:*:*:subnet/*
67+
- action:
68+
- ec2:DescribeVpcs
69+
effect: Allow
70+
resource: "*"
71+
secretRef:
72+
name: aws-load-balancer-operator
73+
namespace: aws-load-balancer-operator
74+
serviceAccountNames:
75+
- aws-load-balancer-operator-controller-manager
76+
----
77+
78+
.. Create the `CredentialsRequest` object by running the following command:
79+
+
80+
[source,terminal]
81+
----
82+
$ oc apply -f credentialsrequest.yaml
83+
----
84+
85+
. Create an `OperatorGroup` object:
86+
87+
.. Create a YAML file that defines the `OperatorGroup` object:
88+
+
89+
.Example `operatorgroup.yaml` file
90+
[source,yaml]
91+
----
92+
apiVersion: operators.coreos.com/v1
93+
kind: OperatorGroup
94+
metadata:
95+
name: aws-lb-operatorgroup
96+
namespace: aws-load-balancer-operator
97+
spec:
98+
upgradeStrategy: Default
99+
----
100+
101+
.. Create the `OperatorGroup` object by running the following command:
102+
+
103+
[source,terminal]
104+
----
105+
$ oc apply -f operatorgroup.yaml
106+
----
107+
108+
. Create a `Subscription` object:
109+
110+
.. Create a YAML file that defines the `Subscription` object:
111+
+
112+
.Example `subscription.yaml` file
113+
[source,yaml]
114+
----
115+
apiVersion: operators.coreos.com/v1alpha1
116+
kind: Subscription
117+
metadata:
118+
name: aws-load-balancer-operator
119+
namespace: aws-load-balancer-operator
120+
spec:
121+
channel: stable-v1
122+
installPlanApproval: Automatic
123+
name: aws-load-balancer-operator
124+
source: qe-app-registry
125+
sourceNamespace: openshift-marketplace
126+
----
127+
128+
.. Create the `Subscription` object by running the following command:
129+
+
130+
[source,terminal]
131+
----
132+
$ oc apply -f subscription.yaml
133+
----
134+
135+
.Verification
136+
137+
. Get the name of the install plan from the subscription:
138+
+
139+
[source,terminal]
140+
----
141+
$ oc -n aws-load-balancer-operator \
142+
get subscription aws-load-balancer-operator \
143+
--template='{{.status.installplan.name}}{{"\n"}}'
144+
----
145+
146+
. Check the status of the install plan:
147+
+
148+
[source,terminal]
149+
----
150+
$ oc -n aws-load-balancer-operator \
151+
get ip <install_plan_name> \
152+
--template='{{.status.phase}}{{"\n"}}'
153+
----
154+
+
155+
The output must be `Complete`.

‎modules/installing-aws-load-balancer-operator.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="nw-installing-aws-load-balancer-operator_{context}"]
7-
= Installing the AWS Load Balancer Operator
7+
= Installing the AWS Load Balancer Operator by using the web console
88

9-
You can install the AWS Load Balancer Operator from the OperatorHub by using the {product-title} web console.
9+
You can install the AWS Load Balancer Operator by using the web console.
1010

1111
.Prerequisites
1212

1313
* You have logged in to the {product-title} web console as a user with `cluster-admin` permissions.
1414
1515
* Your cluster is configured with AWS as the platform type and cloud provider.
1616
17+
* If you are using a security token service (STS) or user-provisioned infrastructure, follow the related preparation steps. For example, if you are using AWS Security Token Service, see "Preparing for the AWS Load Balancer Operator on a cluster using the AWS Security Token Service (STS)".
18+
1719
.Procedure
1820

1921
. Navigate to *Operators* → *OperatorHub* in the {product-title} web console.
2022
. Select the *AWS Load Balancer Operator*. You can use the *Filter by keyword* text box or use the filter list to search for the AWS Load Balancer Operator from the list of Operators.
2123
. Select the `aws-load-balancer-operator` namespace.
22-
. Follow the instructions to prepare the Operator for installation.
23-
. On the *AWS Load Balancer Operator* page, click *Install*.
2424
. On the *Install Operator* page, select the following options:
2525
.. *Update the channel* as *stable-v1*.
26-
.. *Installation mode* as *A specific namespace on the cluster*.
26+
.. *Installation mode* as *All namespaces on the cluster (default)*.
2727
.. *Installed Namespace* as `aws-load-balancer-operator`. If the `aws-load-balancer-operator` namespace does not exist, it gets created during the Operator installation.
2828
.. Select *Update approval* as *Automatic* or *Manual*. By default, the *Update approval* is set to *Automatic*. If you select automatic updates, the Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without any intervention. If you select manual updates, the OLM creates an update request. As a cluster administrator, you must then manually approve that update request to update the Operator updated to the new version.
29-
.. Click *Install*.
29+
. Click *Install*.
3030

3131
.Verification
3232

33-
* Verify that the AWS Load Balancer Operator shows the *Status* as *Succeeded* on the Installed Operators dashboard.
33+
* Verify that the AWS Load Balancer Operator shows the *Status* as *Succeeded* on the Installed Operators dashboard.

‎networking/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="nw-aws-load-balancer-operator"]
3-
= Understanding AWS Load Balancer Operator
3+
= Installing the AWS Load Balancer Operator
44
include::_attributes/common-attributes.adoc[]
55
:context: aws-load-balancer-operator
66

@@ -9,3 +9,5 @@ toc::[]
99
The AWS Load Balancer Operator deploys and manages the AWS Load Balancer Controller. You can install the AWS Load Balancer Operator from the OperatorHub by using {product-title} web console or CLI.
1010

1111
include::modules/installing-aws-load-balancer-operator.adoc[leveloffset=+1]
12+
13+
include::modules/installing-aws-load-balancer-operator-cli.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)