OSDOCS#9377: AWS Load Balancer Operator: Content Improvement#70387
OSDOCS#9377: AWS Load Balancer Operator: Content Improvement#70387mburke5678 merged 1 commit intoopenshift:mainfrom
Conversation
|
🤖 Tue Apr 02 07:47:33 - Prow CI generated the docs preview: |
|
/label peer-review-needed |
opayne1
left a comment
There was a problem hiding this comment.
Sorry again for the late review!! I had just a couple thoughts to consider, but overall looks great! I personally would still get a QE sign off because there are changes to some of the terminology or removes some technical terminology.
modules/adding-tls-termination.adoc
Outdated
| <3> The Amazon Resource Name of the certificate that you attach to the load balancer. | ||
| <4> Defines the ingress class name. | ||
| <1> Specifies the Ingress name. | ||
| <2> The controller provisions the load balancer for Ingress in a public subnet to access load balancer over the internet. |
There was a problem hiding this comment.
| <2> The controller provisions the load balancer for Ingress in a public subnet to access load balancer over the internet. | |
| <2> The controller provisions the load balancer for Ingress in a public subnet to access the load balancer over the internet. |
I am thinking maybe there should be a "the" before load balancer, but then you have another "the" before internet so I am not sure. Just a thought.
| . Create a `service` resource: | ||
| . Create a YAML file that defines the `Service` resource: | ||
| + | ||
| .Example `service-albo.yaml` file |
There was a problem hiding this comment.
| .Example `service-albo.yaml` file | |
| .Example `service-albo.yaml` file: |
There was a problem hiding this comment.
@opayne1 @xenolinux I don't think we need a colon here, right? This is a heading.
| . Deploy an ALB-backed `Ingress` resource: | ||
| . Create a YAML file that defines the `Ingress` resource: | ||
| + | ||
| .Example `ingress-albo.yaml` file |
There was a problem hiding this comment.
| .Example `ingress-albo.yaml` file | |
| .Example `ingress-albo.yaml` file: |
There was a problem hiding this comment.
@opayne1 @xenolinux I don't think we need a colon here, right? This is a heading.
There was a problem hiding this comment.
@mburke5678 That's right. Removed the colon
| <1> Defines the ingress resource. | ||
| <2> Specifies the name of the ingress resource. | ||
| <3> Specifies the name of the service resource. | ||
| <2> Specifies the ingress name. |
There was a problem hiding this comment.
Is Ingress supposed to be capital? I saw some instances where you made the lowercase capital and didn't know if that applies here.
There was a problem hiding this comment.
Nice catch! I updated "ingress" instances per https://redhat-documentation.github.io/supplementary-style-guide/#ingress
There was a problem hiding this comment.
I'm a little confused. This definition says, and its also my understanding, that when referring to an Ingress resource or the Ingress Controller, it should be capitalized and when describing traffic direction, its lowercase.
| . Create an `AWSLoadBalancerController` resource file named `example-sts-iam-role.yaml` with contents such as the following example: | ||
| . Create a YAML file that defines the `AWSLoadBalancerController` object: | ||
| + | ||
| Example `sample-aws-lb-manual-creds.yaml` file |
There was a problem hiding this comment.
| Example `sample-aws-lb-manual-creds.yaml` file | |
| Example `sample-aws-lb-manual-creds.yaml` file: |
There was a problem hiding this comment.
@opayne1 @xenolinux I don't think we need a colon here, right? This is a heading.
| toc::[] | ||
|
|
||
| You can route the traffic to different services that are part of a single domain through a single AWS Load Balancer (ALB). Each Ingress resource provides different endpoints of the domain. | ||
| You can route the traffic to different services that are part of a single domain through a single AWS Load Balancer. Each Ingress provides different endpoints of the domain. |
There was a problem hiding this comment.
I almost feel like resource should be left in here or add something else like "class" or "instance" because it specifies Ingress. Just a thought.
cdbd7e3 to
2755673
Compare
| :_mod-docs-content-type: PROCEDURE | ||
| [id="using-aws-cli-create-iam-role-alb-controller_{context}"] | ||
| = Using the AWS CLI to create an IAM role for the Controller | ||
| = Creating an AWS IAM role for the AWS Load Balancer Controller |
There was a problem hiding this comment.
If change to this, then we have two same subtitle of Creating an AWS IAM role for the AWS Load Balancer Controller
There was a problem hiding this comment.
Modified the title
| :_mod-docs-content-type: PROCEDURE | ||
| [id="using-ccoctl-create-iam-role-alb-controller_{context}"] | ||
| = Using ccoctl to create an IAM role for the Controller | ||
| = Creating an AWS IAM role for the AWS Load Balancer Controller |
There was a problem hiding this comment.
Addressed. Modified the title
| * Using the `ccoctl` binary and a predefined `CredentialsRequest` object. | ||
| * Using the AWS CLI and predefined AWS manifests. | ||
|
|
||
| Use the AWS CLI if your environment does not support the `ccoctl` command. |
There was a problem hiding this comment.
maybe we could add link to ccoctl utility https://docs.openshift.com/container-platform/4.13/authentication/managing_cloud_provider_credentials/cco-mode-sts.html#cco-ccoctl-configuring_cco-mode-sts
Because in that page we could see the note that only Linux supports ccoctl.
The ccoctl utility is a Linux binary that must run in a Linux environment.
b38ba0c to
41fcff0
Compare
|
LGTM. thank you! |
|
/remove-label merge-review-in-progress |
| .Procedure | ||
|
|
||
| . You can deploy the AWS Load Balancer Operator on demand from the OperatorHub, by creating a `Subscription` object: | ||
| . You can deploy the AWS Load Balancer Operator on-demand from OperatorHub, by creating a `Subscription` object by running the following command: |
There was a problem hiding this comment.
Per ISG, on-demand (with hyphen) is an adjective; on demand (no hyphen) is an adverb. Here, on-demand refers to deploy, and is an adverb.
| . You can deploy the AWS Load Balancer Operator on-demand from OperatorHub, by creating a `Subscription` object by running the following command: | |
| . You can deploy the AWS Load Balancer Operator on demand from OperatorHub, by creating a `Subscription` object by running the following command: |
I'm not sure if the following makes sense, but here is the comparision:
| . You can deploy the AWS Load Balancer Operator on-demand from OperatorHub, by creating a `Subscription` object by running the following command: | |
| . You can deploy the on-demand AWS Load Balancer Operator from OperatorHub, by creating a `Subscription` object by running the following command: |
| .Procedure | ||
|
|
||
| . You can deploy the AWS Load Balancer Operator on demand from the OperatorHub, by creating a `Subscription` object: | ||
| . You can deploy the AWS Load Balancer Operator on demand from OperatorHub, by creating a `Subscription` object by running the following command: |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'on-demand' rather than 'on demand'.
There was a problem hiding this comment.
Seems like this rule might need an update to stop false positives 🤔
| = Creating an AWS IAM role by using the Cloud Credential Operator utility | ||
|
|
||
| You can use the `aws` command line interface to create an IAM role for the AWS Load Balancer (ALB) Operator. The created IAM role is used to interact with subnets and Virtual Private Clouds (VPCs). | ||
| You can use the AWS command line interface to create an IAM role for the AWS Load Balancer Operator. The IAM role is used to interact with subnets and Virtual Private Clouds (VPCs). |
There was a problem hiding this comment.
| You can use the AWS command line interface to create an IAM role for the AWS Load Balancer Operator. The IAM role is used to interact with subnets and Virtual Private Clouds (VPCs). | |
| You can use the AWS Command Line Interface to create an IAM role for the AWS Load Balancer Operator. The IAM role is used to interact with subnets and Virtual Private Clouds (VPCs). |
| .Prerequisites | ||
|
|
||
| * You must have access to the `aws` command line interface. | ||
| * You must have access to the AWS command line interface (`aws`). |
There was a problem hiding this comment.
| * You must have access to the AWS command line interface (`aws`). | |
| * You must have access to the AWS Command Line Interface (`aws`). |
| .Procedure | ||
|
|
||
| . You can deploy the AWS Load Balancer Operator on demand from the OperatorHub, by creating a `Subscription` object: | ||
| . You can deploy the AWS Load Balancer Operator on demand from OperatorHub, by creating a `Subscription` object by running the following command: |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'on-demand' rather than 'on demand'.
|
@xenolinux: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
|
/cherrypick enterprise-4.12 |
|
/cherrypick enterprise-4.13 |
|
/cherrypick enterprise-4.14 |
|
/cherrypick enterprise-4.15 |
|
/cherrypick enterprise-4.16 |
|
@mburke5678: #70387 failed to apply on top of branch "enterprise-4.12": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@mburke5678: #70387 failed to apply on top of branch "enterprise-4.13": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@mburke5678: new pull request created: #74036 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@mburke5678: new pull request created: #74037 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@mburke5678: new pull request created: #74038 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@xenolinux Can you PTAL at the 4.12 and 4.13 cherrypicks? There are some significant differences in those branches. |
Version(s): 4.12+
Issue: https://issues.redhat.com/browse/OSDOCS-9377
Link to docs preview: https://70387--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator
QE review:
Additional information: