Skip to content

Commit bd7127a

Browse files
authored
Merge pull request #41083 from mburke5678/OSDOCS2164_alibaba_install
OSDOCS2164: Alibaba install
2 parents 17de9d1 + 220fee8 commit bd7127a

23 files changed

+1019
-47
lines changed

_attributes/common-attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,5 @@ endif::[]
6060
:pipelines-ver: pipelines-1.6
6161
//odo
6262
:odo-title: odo
63+
//alibaba cloud
64+
:alibaba: Alibaba Cloud

_topic_maps/_topic_map.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,20 @@ Topics:
117117
File: installing-mirroring-installation-images
118118
- Name: Mirroring images for a disconnected installation using the oc-mirror plug-in
119119
File: installing-mirroring-disconnected
120+
- Name: Installing on Alibaba
121+
Dir: installing_alibaba
122+
Distros: openshift-origin,openshift-enterprise
123+
Topics:
124+
- Name: Preparing to install on Alibaba Cloud
125+
File: preparing-to-install-on-alibaba
126+
- Name: Creating the required Alibaba Cloud resources
127+
File: manually-creating-alibaba-ram
128+
- Name: Installing a cluster quickly on Alibaba Cloud
129+
File: installing-alibaba-default
130+
- Name: Installing a cluster on Alibaba Cloud with customizations
131+
File: installing-alibaba-customizations
132+
- Name: Uninstalling a cluster on Alibaba Cloud
133+
File: uninstall-cluster-alibaba
120134
- Name: Installing on AWS
121135
Dir: installing_aws
122136
Distros: openshift-origin,openshift-enterprise

authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ Mint mode is the default and recommended best practice setting for the CCO to us
3333
|====
3434
|Cloud provider |Mint |Passthrough |Manual
3535

36+
|{alibaba}
37+
|
38+
|
39+
|X
40+
3641
|Amazon Web Services (AWS)
3742
|X
3843
|X

authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Manual mode is supported for Amazon Web Services (AWS), Microsoft Azure, IBM Cloud, and Google Cloud Platform (GCP).
9+
Manual mode is supported for Alibaba Cloud, Amazon Web Services (AWS), Microsoft Azure, IBM Cloud, and Google Cloud Platform (GCP).
1010

1111
In manual mode, a user manages cloud credentials instead of the Cloud Credential Operator (CCO). To use this mode, you must examine the `CredentialsRequest` CRs in the release image for the version of {product-title} that you are running or installing, create corresponding credentials in the underlying cloud provider, and create Kubernetes Secrets in the correct namespaces to satisfy all `CredentialsRequest` CRs for the cluster's cloud provider.
1212

1313
Using manual mode allows each cluster component to have only the permissions it requires, without storing an administrator-level credential in the cluster. This mode also does not require connectivity to the AWS public IAM endpoint. However, you must manually reconcile permissions with new release images for every upgrade.
1414

15-
For information about configuring your cloud provider to use manual mode, see _Manually creating IAM_ for xref:../../installing/installing_aws/manually-creating-iam.adoc#manually-creating-iam-aws[AWS], xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Azure], xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[IBM Cloud], or xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-creating-iam-gcp[GCP].
15+
For information about configuring your cloud provider to use manual mode, see _Manually creating RAM resources_ for xref:../../installing/installing_alibaba/installing-alibaba-default.adoc#installation-initializing_installing-alibaba-default[Alibaba Cloud], xref:../../installing/installing_aws/manually-creating-iam.adoc#manually-creating-iam-aws[AWS], xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Azure], xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[IBM Cloud], or xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-creating-iam-gcp[GCP].
1616

1717
[id="manual-mode-sts-blurb"]
1818
== Manual mode with AWS STS
@@ -25,6 +25,7 @@ include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
2525
[id="additional-resources_cco-mode-manual"]
2626
== Additional resources
2727

28+
* xref:../../installing/installing_alibaba/manually-creating-alibaba-ram.adoc#manually-creating-alibaba-ram[Manually creating RAM resources for Alibaba Cloud]
2829
* xref:../../installing/installing_aws/manually-creating-iam.adoc#manually-creating-iam-aws[Manually creating IAM for AWS]
2930
* xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Manually creating IAM for Azure]
3031
* xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-creating-iam-gcp[Manually creating IAM for GCP]

installing/installing-preparing.adoc

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Before you install an {product-title} cluster, you need to select the best insta
1717

1818
If you want to install and manage {product-title} yourself, you can install it on the following platforms:
1919

20+
* Alibaba Cloud
2021
* Amazon Web Services (AWS) on x86_64 instances
2122
* Amazon Web Services (AWS) on arm64 instances
2223
* Microsoft Azure
@@ -49,9 +50,9 @@ Because you need to provision machines as part of the {product-title} cluster in
4950

5051
Because the operating system is integral to {product-title}, it is easier to let the installation program for {product-title} stand up all of the infrastructure. These are called _installer provisioned infrastructure_ installations. In this type of installation, you can provide some existing infrastructure to the cluster, but the installation program deploys all of the machines that your cluster initially needs.
5152

52-
You can deploy an installer-provisioned infrastructure cluster without specifying any customizations to the cluster or its underlying machines to xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[AWS], xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[Azure], xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Azure Stack Hub], xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[GCP], or xref:../installing/installing_vmc/installing-vmc.adoc#installing-vmc[VMC on AWS]. These installation methods are the fastest way to deploy a production-capable {product-title} cluster.
53+
You can deploy an installer-provisioned infrastructure cluster without specifying any customizations to the cluster or its underlying machines to xref:../installing/installing_alibaba/installing-alibaba-default.adoc#installing-alibaba-default[Alibaba Cloud], xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[AWS], xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[Azure], xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Azure Stack Hub], xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[GCP], or xref:../installing/installing_vmc/installing-vmc.adoc#installing-vmc[VMC on AWS]. These installation methods are the fastest way to deploy a production-capable {product-title} cluster.
5354

54-
If you need to perform basic configuration for your installer-provisioned infrastructure cluster, such as the instance type for the cluster machines, you can customize an installation for xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[Azure], xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[GCP], or xref:../installing/installing_vmc/installing-vmc-customizations.adoc#installing-vmc-customizations[VMC on AWS].
55+
If you need to perform basic configuration for your installer-provisioned infrastructure cluster, such as the instance type for the cluster machines, you can customize an installation for xref:../installing/installing_alibaba/installing-alibaba-customizations.adoc#installing-alibaba-customizations[Alibaba Cloud], xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[Azure], xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[GCP], or xref:../installing/installing_vmc/installing-vmc-customizations.adoc#installing-vmc-customizations[VMC on AWS].
5556

5657
For installer-provisioned infrastructure installations, you can use an existing xref:../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[VPC in AWS], xref:../installing/installing_azure/installing-azure-vnet.adoc#installing-azure-vnet[vNet in Azure], or xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[VPC in GCP]. You can also reuse part of your networking infrastructure so that your cluster in xref:../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[AWS], xref:../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Azure], xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[GCP], or xref:../installing/installing_vmc/installing-vmc-network-customizations.adoc#installing-vmc-network-customizations[VMC on AWS] can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. If you have existing accounts and credentials on these clouds, you can re-use them, but you might need to modify the accounts to have the required permissions to install {product-title} clusters on them.
5758

@@ -121,13 +122,14 @@ Not all installation options are supported for all platforms, as shown in the fo
121122
.Installer-provisioned infrastructure options
122123
|===
123124
ifndef::openshift-origin[]
124-
||AWS (x86_64) |AWS (arm64) |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Power
125+
||Alibaba |AWS (x86_64) |AWS (arm64) |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Power
125126
endif::openshift-origin[]
126127
ifdef::openshift-origin[]
127-
||AWS |Azure |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Power
128+
||Alibaba||AWS |Azure |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Power
128129
endif::openshift-origin[]
129130

130131
|Default
132+
|xref:../installing/installing_alibaba/installing-alibaba-default.adoc#installing-alibaba-default[X]
131133
|xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[X]
132134
|xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[X]
133135
|xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[X]
@@ -144,6 +146,7 @@ endif::openshift-origin[]
144146
|
145147

146148
|Custom
149+
|xref:../installing/installing_alibaba/installing-alibaba-customizations.adoc#installing-alibaba-customizations[X]
147150
|xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[X]
148151
|xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[X]
149152
|xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[X]
@@ -160,6 +163,7 @@ endif::openshift-origin[]
160163
|
161164

162165
|Network customization
166+
|
163167
|xref:../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[X]
164168
|xref:../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[X]
165169
|xref:../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-network-customizations[X]
@@ -176,6 +180,7 @@ endif::openshift-origin[]
176180
|
177181

178182
|Restricted network
183+
|
179184
|xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[X]
180185
|
181186
|
@@ -192,6 +197,7 @@ endif::openshift-origin[]
192197
|
193198

194199
|Private clusters
200+
|
195201
|xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[X]
196202
|xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[X]
197203
|xref:../installing/installing_azure/installing-azure-private.adoc#installing-azure-private[X]
@@ -208,6 +214,7 @@ endif::openshift-origin[]
208214
|
209215

210216
|Existing virtual private networks
217+
|
211218
|xref:../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[X]
212219
|xref:../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[X]
213220
|xref:../installing/installing_azure/installing-azure-vnet.adoc#installing-azure-vnet[X]
@@ -224,6 +231,7 @@ endif::openshift-origin[]
224231
|
225232

226233
|Government regions
234+
|
227235
|xref:../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-government-region[X]
228236
|
229237
|xref:../installing/installing_azure/installing-azure-government-region.adoc#installing-azure-government-region[X]
@@ -240,6 +248,7 @@ endif::openshift-origin[]
240248
|
241249

242250
|China regions
251+
|
243252
|xref:../installing/installing_aws/installing-aws-china.adoc#installing-aws-china-region[X]
244253
|
245254
|
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
:_content-type: ASSEMBLY
2+
[id="installing-alibaba-customizations"]
3+
= Installing a cluster on Alibaba Cloud with customizations
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-alibaba-customizations
6+
7+
toc::[]
8+
9+
In {product-title} version {product-version}, you can install a customized cluster on infrastructure that the installation program provisions on Alibaba Cloud. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster.
10+
11+
[NOTE]
12+
====
13+
The scope of the {product-title} installation configurations is intentionally narrow. It is designed for simplicity and ensured success. You can complete many more {product-title} configuration tasks after an installation completes.
14+
====
15+
16+
:FeatureName: Alibaba Cloud on {product-title}
17+
include::snippets/technology-preview.adoc[]
18+
19+
[id="prerequisites_installing-alibaba-customizations"]
20+
== Prerequisites
21+
22+
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
23+
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
24+
* You xref:../../installing/installing_alibaba/preparing-to-install-on-alibaba.html#installation-alibaba-dns_preparing-to-install-on-alibaba[registered your domain].
25+
* 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.
26+
* 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].
27+
28+
include::modules/cluster-entitlements.adoc[leveloffset=+1]
29+
30+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
31+
32+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
33+
34+
include::modules/installation-initializing.adoc[leveloffset=+2]
35+
36+
include::modules/manually-creating-alibaba-manifests.adoc[leveloffset=+2]
37+
38+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+2]
39+
40+
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
41+
42+
include::modules/installation-alibaba-config-yaml.adoc[leveloffset=+2]
43+
44+
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
45+
46+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
47+
48+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
49+
50+
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
51+
52+
include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1]
53+
54+
include::modules/cluster-telemetry.adoc[leveloffset=+1]
55+
56+
[role="_additional-resources"]
57+
.Additional resources
58+
59+
* 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.
60+
* 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
61+
* 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.
62+
63+
[id="next-steps_installing-alibaba-customizations"]
64+
== Next steps
65+
66+
* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
67+
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
68+
* 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].
69+
//Given that manual mode is required to install on Alibaba Cloud, I do not believe this xref is necessary.
70+
//* 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].

0 commit comments

Comments
 (0)