Skip to content

Commit c5d6fe7

Browse files
committed
OSDOCS-11553: Move AWS Outposts content to install book
1 parent 05e9773 commit c5d6fe7

14 files changed

+109
-121
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Topics:
182182
File: installing-aws-localzone
183183
- Name: Installing a cluster with compute nodes on Wavelength Zones
184184
File: installing-aws-wavelength-zone
185-
- Name: Installing a cluster with compute nodes on Outposts
185+
- Name: Extending an AWS VPC cluster into an AWS Outpost
186186
File: installing-aws-outposts
187187
- Name: User-provisioned infrastructure
188188
Dir: upi
@@ -654,8 +654,6 @@ Topics:
654654
- Name: AWS Local Zone or Wavelength Zone tasks
655655
File: aws-compute-edge-zone-tasks
656656
Distros: openshift-enterprise
657-
- Name: Extending an AWS VPC cluster into an AWS Outpost
658-
File: configuring-aws-outposts
659657
---
660658
Name: Updating clusters
661659
Dir: updating
Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,89 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="installing-aws-outposts"]
3-
= Installing a cluster with compute nodes on AWS Outposts
3+
= Extending an AWS VPC cluster into an AWS Outpost
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-aws-outposts
6+
:zone-type: AWS Outposts
67

78
toc::[]
89

9-
In {product-title} version 4.14, you could install a cluster on Amazon Web Services (AWS) with compute nodes running in AWS Outposts as a Technology Preview. As of {product-title} version 4.15, this installation method is no longer supported.
10+
In {product-title} version 4.14, you could install a cluster on Amazon Web Services (AWS) with compute nodes running in AWS Outposts as a Technology Preview. As of {product-title} version 4.15, this installation method is no longer supported. Instead, you can install a cluster on AWS into an existing VPC, and provision compute nodes on AWS Outposts as a postinstallation configuration task.
1011

11-
Instead, you can xref:../../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[install a cluster on AWS into an existing VPC] and provision compute nodes on AWS Outposts as a postinstallation configuration task.
12+
After xref:../../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[installing a cluster on Amazon Web Services (AWS) into an existing Amazon Virtual Private Cloud (VPC)], you can create a compute machine set that deploys compute machines in AWS Outposts.
13+
AWS Outposts is an AWS edge compute service that enables using many features of a cloud-based AWS deployment with the reduced latency of an on-premise environment.
14+
For more information, see the link:https://docs.aws.amazon.com/outposts/[AWS Outposts documentation].
1215

13-
For more information, see xref:../../../post_installation_configuration/configuring-aws-outposts.adoc#configuring-aws-outposts[Extending an AWS VPC cluster into an AWS Outpost]
16+
//AWS Outposts on {product-title} requirements and limitations
17+
include::modules/aws-outposts-requirements-limitations.adoc[leveloffset=+1]
18+
[role="_additional-resources"]
19+
.Additional resources
20+
* xref:../../../installing/installing_aws/ipi/installing-aws-outposts.adoc#nw-aws-load-balancer-with-outposts_installing-aws-outposts[Using the AWS Load Balancer Operator in an AWS VPC cluster extended into an Outpost]
21+
22+
[id="aws-outposts-environment-info_{context}"]
23+
== Obtaining information about your environment
24+
25+
To extend an AWS VPC cluster to your Outpost, you must provide information about your {product-title} cluster and your Outpost environment.
26+
You use this information to complete network configuration tasks and configure a compute machine set that creates compute machines in your Outpost.
27+
You can use command-line tools to gather the required details.
28+
29+
//Obtaining information from your {product-title} cluster
30+
include::modules/aws-outposts-environment-info-oc.adoc[leveloffset=+2]
31+
32+
//Obtaining information from your AWS account
33+
include::modules/aws-outposts-environment-info-aws.adoc[leveloffset=+2]
34+
35+
[id="aws-outposts-network-config_{context}"]
36+
== Configuring your network for your Outpost
37+
38+
To extend your VPC cluster into an Outpost, you must complete the following network configuration tasks:
39+
40+
* Change the Cluster Network MTU.
41+
* Create a subnet in your Outpost.
42+
43+
//Changing the Cluster Network MTU to support AWS Outposts
44+
include::modules/nw-cluster-mtu-change.adoc[leveloffset=+2]
45+
[role="_additional-resources"]
46+
.Additional resources
47+
* xref:../../../networking/changing-cluster-network-mtu.adoc#changing-cluster-network-mtu[Changing the MTU for the cluster network]
48+
49+
//Creating subnets for AWS edge compute services
50+
include::modules/installation-creating-aws-vpc-subnets-edge.adoc[leveloffset=+2]
51+
52+
//CloudFormation template for the VPC Subnet
53+
include::modules/installation-cloudformation-subnet-localzone.adoc[leveloffset=+2]
54+
55+
//Creating a compute machine set that deploys edge compute machines an Outpost
56+
include::modules/aws-outposts-machine-set.adoc[leveloffset=+1]
57+
58+
//Creating user workloads in an Outpost
59+
include::modules/create-user-workloads-aws-edge.adoc[leveloffset=+1]
60+
//To-do: reintegrate installation-extend-edge-nodes-aws-local-zones.adoc with create-user-workloads-aws-edge.adoc. Requires global repo update of any xrefs/includes.
61+
62+
[id="aws-outposts-network-scheduling-workloads_{context}"]
63+
== Scheduling workloads on edge and cloud-based AWS compute resources
64+
65+
When you extend an AWS VPC cluster into an Outpost, the Outpost uses edge compute nodes and the VPC uses cloud-based compute nodes.
66+
The following load balancer considerations apply to an AWS VPC cluster extended into an Outpost:
67+
68+
* Outposts cannot run AWS Network Load Balancers or AWS Classic Load Balancers, but a Classic Load Balancer for a VPC cluster extended into an Outpost can attach to the Outpost edge compute nodes.
69+
For more information, see xref:../../../installing/installing_aws/ipi/installing-aws-outposts.adoc#aws-outposts-load-balancer-clb_installing-aws-outposts[Using AWS Classic Load Balancers in an AWS VPC cluster extended into an Outpost].
70+
71+
* To run a load balancer on an Outpost instance, you must use an AWS Application Load Balancer.
72+
You can use the AWS Load Balancer Operator to deploy an instance of the AWS Load Balancer Controller.
73+
The controller provisions AWS Application Load Balancers for Kubernetes Ingress resources.
74+
For more information, see xref:../../../installing/installing_aws/ipi/installing-aws-outposts.adoc#nw-aws-load-balancer-with-outposts_installing-aws-outposts[Using the AWS Load Balancer Operator in an AWS VPC cluster extended into an Outpost].
75+
76+
//Using Classic Load Balancers in an AWS VPC cluster extended into an Outpost
77+
include::modules/aws-outposts-load-balancer-clb.adoc[leveloffset=+2]
78+
79+
//Using the AWS Load Balancer Operator in an AWS VPC cluster extended into an Outpost
80+
include::modules/nw-aws-load-balancer-with-outposts.adoc[leveloffset=+2]
81+
82+
[role="_additional-resources"]
83+
.Additional resources
84+
* xref:../../../networking/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc#nw-creating-instance-aws-load-balancer-controller_create-instance-aws-load-balancer[Creating an instance of the AWS Load Balancer Controller using AWS Load Balancer Operator]
85+
86+
[role="_additional-resources"]
87+
[id="additional-installing-aws-outposts"]
88+
== Additional resources
89+
* xref:../../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[Installing a cluster on AWS into an existing VPC]

installing/installing_aws/ipi/installing-aws-vpc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
105105
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
106106
* If necessary, you can xref:../../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
107107
* If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials].
108-
* After installing a cluster on AWS into an existing VPC, you can xref:../../../post_installation_configuration/configuring-aws-outposts.adoc#configuring-aws-outposts[extend the AWS VPC cluster into an AWS Outpost].
108+
* After installing a cluster on AWS into an existing VPC, you can xref:../../../installing/installing_aws/ipi/installing-aws-outposts.adoc#installing-aws-outposts[extend the AWS VPC cluster into an AWS Outpost].

modules/aws-outposts-environment-info-aws.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * post_installation_configuration/configuring-aws-outposts.adoc
3+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-outposts-environment-info-aws_{context}"]
@@ -57,4 +57,4 @@ $ aws outposts get-outpost-instance-types \
5757
----
5858
$ aws ec2 describe-subnets \
5959
--filters Name=outpost-arn,Values=<outpost_arn_value>
60-
----
60+
----

modules/aws-outposts-environment-info-oc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * post_installation_configuration/configuring-aws-outposts.adoc
3+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-outposts-environment-info-oc_{context}"]
@@ -63,4 +63,4 @@ $ oc get machinesets.machine.openshift.io <compute_machine_set_name_1> \
6363
$ oc get machinesets.machine.openshift.io <compute_machine_set_name_1> \
6464
-n openshift-machine-api \
6565
-o jsonpath='{.spec.template.spec.providerSpec.value.subnet.id}'
66-
----
66+
----

modules/aws-outposts-load-balancer-clb.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * post_installation_configuration/configuring-aws-outposts.adoc
3+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-outposts-load-balancer-clb_{context}"]
@@ -120,4 +120,4 @@ $ HOST=$(oc get service <application_name> -n <application_namespace> --template
120120
$ curl $HOST
121121
----
122122

123-
. In the AWS console, verify that only the labeled instances appear as the targeted instances for the load balancer.
123+
. In the AWS console, verify that only the labeled instances appear as the targeted instances for the load balancer.

modules/aws-outposts-machine-set.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * post_installation_configuration/configuring-aws-outposts.adoc
3+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-outposts-machine-set_{context}"]
@@ -216,4 +216,4 @@ NAME PHASE TYPE REGION ZONE
216216
[source,terminal]
217217
----
218218
$ oc describe machine <machine_from_new_1> -n openshift-machine-api
219-
----
219+
----

modules/aws-outposts-requirements-limitations.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * post_installation_configuration/configuring-aws-outposts.adoc
3+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="aws-outposts-requirements-limitations_{context}"]
@@ -44,4 +44,4 @@ You must use AWS Application Load Balancers to enable load balancing for edge co
4444
To provision an Application Load Balancer, you must use an Ingress resource and install the AWS Load Balancer Operator.
4545
If your cluster contains both edge and cloud-based compute instances that share workloads, additional configuration is required.
4646
+
47-
For more information, see "Using the AWS Load Balancer Operator in an AWS VPC cluster extended into an Outpost".
47+
For more information, see "Using the AWS Load Balancer Operator in an AWS VPC cluster extended into an Outpost".

modules/create-user-workloads-aws-edge.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * post_installation_configuration/configuring-aws-outposts.adoc
3+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
44

55
//To-do: reintegrate installation-extend-edge-nodes-aws-local-zones.adoc with create-user-workloads-aws-edge.adoc. Requires global repo update of any xrefs/includes.
66

@@ -132,4 +132,4 @@ spec:
132132
[source,terminal]
133133
----
134134
$ oc create -f <application_service>.yaml
135-
----
135+
----

modules/installation-cloudformation-subnet-localzone.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
// * installing/installing-aws-localzone.adoc (Installing a cluster on AWS with worker nodes on AWS Local Zones)
44
// * installing/installing-aws-wavelength-zone.adoc (Installing a cluster on AWS with compute nodes on AWS Wavelength Zones)
55
// * post_installation_configuration/aws-compute-edge-zone-tasks.adoc (AWS zone tasks)
6-
// * post_installation_configuration/configuring-aws-outposts.adoc
6+
// * installing/installing_aws/ipi/installing-aws-outposts.adoc
77

8-
ifeval::["{context}" == "configuring-aws-outposts"]
8+
ifeval::["{context}" == "installing-aws-outposts"]
99
:outposts:
1010
endif::[]
1111

@@ -150,6 +150,6 @@ ifdef::outposts[]
150150
endif::outposts[]
151151
====
152152

153-
ifeval::["{context}" == "configuring-aws-outposts"]
153+
ifeval::["{context}" == "installing-aws-outposts"]
154154
:!outposts:
155-
endif::[]
155+
endif::[]

0 commit comments

Comments
 (0)