-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-16862: CQA2.0 of CORE-3: Ingress Controllers and Load Balancin… #104156
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
@dfitzmau: This pull request references OSDOCS-16862 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
|
🤖 Fri Dec 19 17:01:29 - Prow CI generated the docs preview: |
794762c to
e29a45e
Compare
|
@dfitzmau: This pull request references OSDOCS-16862 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
|
@dfitzmau: This pull request references OSDOCS-16862 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
ba9834e to
9f5031e
Compare
|
@dfitzmau: This pull request references OSDOCS-16862 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
8ec4021 to
afdf9ff
Compare
c3e68f0 to
81213dd
Compare
81213dd to
8f5c3a9
Compare
|
@dfitzmau: This pull request references OSDOCS-16862 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
|
@dfitzmau: 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-sigs/prow repository. I understand the commands that are listed here. |
|
@dfitzmau: This pull request references OSDOCS-16862 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
| .Prerequisites | ||
|
|
||
| * An existing AWS virtual private cloud (VPC). | ||
| * Pre-configured AWS subnets intended for use by the OpenShift cluster, with the following considerations: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * Pre-configured AWS subnets intended for use by the OpenShift cluster, with the following considerations: | |
| * Pre-configured AWS subnets intended for use by the {product-title} cluster, with the following considerations: |
| `baseDomain`:: Your base domain. | ||
| `region`:: Your AWS region. | ||
| `vpc`:: The vpc object under `platform.aws` contains the subnets list. | ||
| `subnets`:: List of all subnet objects that OpenShift will use. Each object defines a subnet id and its roles. | ||
| `id`:: Replace with your AWS Subnet ID. | ||
| `type.IngressControllerLB`:: The `type: IngressControllerLB` role specifically designates this subnet for the default Ingress Controller's LoadBalancer. In private/internal cluster, the subnet with `IngressControllerLB` role must be private. | ||
| `type.ClusterNode`:: The `type: ClusterNode` role designates this subnet for control plane and compute nodes. These are typically private subnets. | ||
| `pullSecret`:: Your pull secret. | ||
| `sshKey`:: Your SSH key. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doc guidelines: introduce the description list with "where:" and start each variable description with "Specifies."
| `baseDomain`:: Your base domain. | |
| `region`:: Your AWS region. | |
| `vpc`:: The vpc object under `platform.aws` contains the subnets list. | |
| `subnets`:: List of all subnet objects that OpenShift will use. Each object defines a subnet id and its roles. | |
| `id`:: Replace with your AWS Subnet ID. | |
| `type.IngressControllerLB`:: The `type: IngressControllerLB` role specifically designates this subnet for the default Ingress Controller's LoadBalancer. In private/internal cluster, the subnet with `IngressControllerLB` role must be private. | |
| `type.ClusterNode`:: The `type: ClusterNode` role designates this subnet for control plane and compute nodes. These are typically private subnets. | |
| `pullSecret`:: Your pull secret. | |
| `sshKey`:: Your SSH key. | |
| `baseDomain`:: Specifies your base domain. | |
| `region`:: Specifies your AWS region. | |
| `vpc`:: Specifies the vpc object under `platform.aws` contains the subnets list. | |
| `subnets`:: Specifies a list of all subnet objects that OpenShift will use. Each object defines a subnet id and its roles. | |
| `id`:: Specifies your AWS Subnet ID. | |
| `type.IngressControllerLB`:: Specifies this subnet for the default Ingress Controller's LoadBalancer. In private/internal cluster, the subnet with `IngressControllerLB` role must be private. | |
| `type.ClusterNode`:: Specifies the `type: ClusterNode` role designates this subnet for control plane and compute nodes. These are typically private subnets. | |
| `pullSecret`:: Specifies your pull secret. | |
| `sshKey`:: Specifies your SSH key. |
| where: | ||
| + | ||
| `<ingress_controller_name>`: Replace `<ingress_controller_name>` with a unique name for the Ingress Controller. | ||
| `<unique_ingress_domain>`:: Replace `<unique_ingress_domain>` with a domain name that is unique among all Ingress Controllers in the cluster. This variable must be a subdomain of the DNS name `<clustername>.<domain>`. | ||
| `scope`:: You can replace `External` with `Internal` to use an internal NLB. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| where: | |
| + | |
| `<ingress_controller_name>`: Replace `<ingress_controller_name>` with a unique name for the Ingress Controller. | |
| `<unique_ingress_domain>`:: Replace `<unique_ingress_domain>` with a domain name that is unique among all Ingress Controllers in the cluster. This variable must be a subdomain of the DNS name `<clustername>.<domain>`. | |
| `scope`:: You can replace `External` with `Internal` to use an internal NLB. | |
| where: | |
| + | |
| `<ingress_controller_name>`: Specifies a unique name for the Ingress Controller. | |
| `<unique_ingress_domain>`:: Specifies a domain name that is unique among all Ingress Controllers in the cluster. This variable must be a subdomain of the DNS name `<clustername>.<domain>`. | |
| `scope`:: Specifies the type of NLB, either `External` to use an external NLB or `Internal` to use an internal NLB. |
| $ touch <installation_directory>/manifests/cluster-ingress-default-ingresscontroller.yaml | ||
| ---- | ||
| <1> For `<installation_directory>`, specify the directory name that contains the | ||
| `<installation_directory>`:: For `<installation_directory>`, specify the directory name that contains the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `<installation_directory>`:: For `<installation_directory>`, specify the directory name that contains the | |
| `<installation_directory>`:: Specifies the directory name that contains the |
| [role="_abstract"] | ||
| You can set parameters in the `Network.config.openshift.io` custom resource (CR) to govern the use of an external IP address in {product-title}. These parameters are listed as follows: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure that this second, introductory, sentence belongs in the abstract. I fear it will get caught up in the DITA short description and get separated from the bullet list that the sentence introduces. (But that is a guess on my part. I started a Slack chat asking about it, but nothing so far.)
Version(s):
4.16+
Issue:
OSDOCS-16862
Link to docs preview:
Continue next PR from networking/ingress_load_balancing/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-load-balancer.adoc