Skip to content

Commit 13ca8ff

Browse files
author
Christopher Tauchen
authored
Merge pull request #42836 from ctauchen/alibaba-net-custom
OSDOCS-2678: Alibaba install with network customizations
2 parents fc59d72 + b239b7a commit 13ca8ff

16 files changed

+103
-7
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ Topics:
129129
File: installing-alibaba-default
130130
- Name: Installing a cluster on Alibaba Cloud with customizations
131131
File: installing-alibaba-customizations
132+
- Name: Installing a cluster on Alibaba Cloud with network customizations
133+
File: installing-alibaba-network-customizations
132134
- Name: Uninstalling a cluster on Alibaba Cloud
133135
File: uninstall-cluster-alibaba
134136
- Name: Installing on AWS
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
:_content-type: ASSEMBLY
2+
[id="installing-alibaba-network-customizations"]
3+
= Installing a cluster on Alibaba Cloud with network customizations
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-alibaba-network-customizations
6+
7+
toc::[]
8+
9+
In {product-title} {product-version}, you can install a cluster on Alibaba Cloud with customized network configuration options. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and
10+
VXLAN configurations.
11+
12+
You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.
13+
14+
:FeatureName: Alibaba Cloud on {product-title}
15+
include::snippets/technology-preview.adoc[]
16+
17+
[id="prerequisites_installing-alibaba-network-customizations"]
18+
== Prerequisites
19+
20+
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
21+
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
22+
* You xref:../../installing/installing_alibaba/preparing-to-install-on-alibaba.html#installation-alibaba-dns_preparing-to-install-on-alibaba[registered your domain].
23+
* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
24+
* If the cloud Resource Access Management (RAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_alibaba/manually-creating-alibaba-ram.adoc#manually-creating-alibaba-ram[manually create and maintain Resource Access Management (RAM) credentials].
25+
26+
include::modules/cluster-entitlements.adoc[leveloffset=+1]
27+
28+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
29+
30+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
31+
32+
//Networking-specific customization module
33+
include::modules/nw-network-config.adoc[leveloffset=+1]
34+
35+
include::modules/installation-initializing.adoc[leveloffset=+2]
36+
37+
include::modules/manually-creating-alibaba-manifests.adoc[leveloffset=+2]
38+
39+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+2]
40+
41+
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
42+
43+
include::modules/installation-alibaba-config-yaml.adoc[leveloffset=+2]
44+
45+
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
46+
47+
//Networking-specific customization module
48+
include::modules/nw-operator-cr.adoc[leveloffset=+1]
49+
50+
//Networking-specific customization module
51+
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
52+
53+
//Networking-specific customization module
54+
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
55+
56+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
57+
58+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
59+
60+
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
61+
62+
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
63+
64+
include::modules/cluster-telemetry.adoc[leveloffset=+1]
65+
66+
[role="_additional-resources"]
67+
.Additional resources
68+
69+
* See xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service.
70+
* See xref:../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console
71+
* See xref:../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console.
72+
73+
[id="next-steps_installing-alibaba-network-customizations"]
74+
== Next steps
75+
76+
* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validate an installation].
77+
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
78+
* 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].
79+
//Given that manual mode is required to install on Alibaba Cloud, I do not believe this xref is necessary.
80+
//* If necessary, you can xref:../../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#manually-removing-cloud-creds_cco-mode-mint[remove cloud provider credentials].

modules/cco-ccoctl-creating-at-once.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc
44
// * installing/installing_alibaba/manually-creating-alibaba-ram.adoc
5+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
56

67
:_content-type: PROCEDURE
78
ifeval::["{context}" == "cco-mode-sts"]
@@ -42,7 +43,7 @@ You must have:
4243

4344
* Extracted and prepared the `ccoctl` binary.
4445
ifdef::alibabacloud-default,alibabacloud-customizations[]
45-
* Created a RAM user with sufficient permission to create the {product-title} cluster.
46+
* Created a RAM user with sufficient permission to create the {product-title} cluster.
4647
* Added the AccessKeyID (`access_key_id`) and AccessKeySecret (`access_key_secret`) of that RAM user into the link:https://www.alibabacloud.com/help/en/doc-detail/311667.htm#h2-sls-mfm-3p3[`~/.alibabacloud/credentials` file] on your local computer.
4748
endif::alibabacloud-default,alibabacloud-customizations[]
4849

modules/cli-installing-cli.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
22
//
3+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
34
// * cli_reference/openshift_cli/getting-started.adoc
45
// * installing/installing_aws/installing-aws-user-infra.adoc
56
// * installing/installing_aws/installing-aws-customizations.adoc

modules/cli-logging-in-kubeadmin.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
22
//
3+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
34
// * installing/installing_aws/installing-aws-user-infra.adoc
45
// * installing/installing_aws/installing-aws-customizations.adoc
56
// * installing/installing_aws/installing-aws-default.adoc

modules/cluster-entitlements.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
22
//
3+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
34
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
45
// * installing/installing_bare_metal/installing-bare-metal.adoc
56
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc

modules/cluster-telemetry.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
22
//
3+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
34
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
45
// * installing/installing_bare_metal/installing-bare-metal.adoc
56
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc

modules/installation-alibaba-config-yaml.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
22
//
3+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
34
// * installing/installing_alibaba/installing-alibaba-customizations.adoc
45

56
:_content-type: REFERENCE

modules/installation-configuration-parameters.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * installing/installing_alibaba//installing-alibaba-default.adoc
44
// * installing/installing_aws/installing-alibaba-customizations.adoc
5+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
56
// * installing/installing_aws/installing-aws-china.adoc
67
// * installing/installing_aws/installing-aws-customizations.adoc
78
// * installing/installing_aws/installing-aws-government-region.adoc
@@ -810,11 +811,11 @@ On clusters that use Kuryr, {rh-openstack} Octavia does not support availability
810811
|A list of strings, for example `["zone-1", "zone-2"]`.
811812

812813
|`compute.platform.openstack.serverGroupPolicy`
813-
|Server group policy to apply to the group that will contain the compute machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
814+
|Server group policy to apply to the group that will contain the compute machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
814815

815816
An `affinity` policy prevents migrations and therefore affects {rh-openstack} upgrades. The `affinity` policy is not supported.
816817

817-
If you use a strict `anti-affinity` policy, an additional {rh-openstack} host is required during instance migration.
818+
If you use a strict `anti-affinity` policy, an additional {rh-openstack} host is required during instance migration.
818819
|A server group policy to apply to the machine pool. For example, `soft-affinity`.
819820

820821
|`controlPlane.platform.openstack.additionalNetworkIDs`
@@ -836,11 +837,11 @@ On clusters that use Kuryr, {rh-openstack} Octavia does not support availability
836837
|A list of strings, for example `["zone-1", "zone-2"]`.
837838

838839
|`controlPlane.platform.openstack.serverGroupPolicy`
839-
|Server group policy to apply to the group that will contain the control plane machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
840+
|Server group policy to apply to the group that will contain the control plane machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
840841

841842
An `affinity` policy prevents migrations, and therefore affects {rh-openstack} upgrades. The `affinity` policy is not supported.
842843

843-
If you use a strict `anti-affinity` policy, an additional {rh-openstack} host is required during instance migration.
844+
If you use a strict `anti-affinity` policy, an additional {rh-openstack} host is required during instance migration.
844845
|A server group policy to apply to the machine pool. For example, `soft-affinity`.
845846

846847
|`platform.openstack.clusterOSImage`
@@ -1436,7 +1437,7 @@ Additional Alibaba Cloud configuration parameters are described in the following
14361437

14371438
|`platform.alibabacloud.defaultMachinePlatform.imageID`
14381439
|For compute machines, the image ID that should be used to create ECS instance. If set, the image ID should belong to the same region as the cluster
1439-
|String.
1440+
|String.
14401441

14411442
|`platform.alibabacloud.defaultMachinePlatform.instanceType`
14421443
|For compute machines, the configuration used when installing on Alibaba Cloud.

modules/installation-configure-proxy.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// Module included in the following assemblies:
22
//
3+
// installing/installing_alibaba/installing-alibaba-network-customizations.adoc
34
// * installing/installing_aws/installing_aws-customizations.adoc
45
// * installing/installing_aws/installing_aws-network-customizations.adoc
56
// * installing/installing_aws/installing_aws-private.adoc

0 commit comments

Comments
 (0)