Skip to content

Commit 0f8199d

Browse files
committed
Update IPI docs
1 parent 5163558 commit 0f8199d

4 files changed

+102
-94
lines changed

modules/creating-ibm-power-vs-workspace-procedure.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Use the following procedure to create an {ibmpowerProductName} Virtual Server wo
1010

1111
. To create an {ibmpowerProductName} Virtual Server workspace, complete step 1 to step 5 from the IBM Cloud documentation for link:https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-power-virtual-server[Creating an IBM Power Virtual Server].
1212

13-
. After it has finished provisioning, retrieve the 32-character alphanumeric ID of your new workspace by entering the following command:
13+
. After it has finished provisioning, retrieve the 32-character alphanumeric Globally Unique Identifier (GUID) of your new workspace by entering the following command:
1414
+
1515
[source,terminal]
1616
----
17-
$ ibmcloud resource service-instances | grep <workspace name>
17+
$ ibmcloud resource service-instance <workspace name>
1818
----
1919
+

modules/installation-cis-ibm-cloud.adoc

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
// installing/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc
44
// installing/installing_ibm_powervs/installing-ibm-cloud-account-power-vs.adoc
55

6+
ifeval::["{context}" == "installing-ibm-cloud-account-power-vs"]
7+
:ibm-power-vs:
8+
endif::[]
9+
610
:_content-type: PROCEDURE
711
[id="installation-cis-ibm-cloud_{context}"]
812
= Using IBM Cloud Internet Services for DNS resolution
@@ -32,6 +36,15 @@ You must create a domain zone in CIS in the same account as your cluster. You mu
3236
$ ibmcloud plugin install cis
3337
----
3438

39+
ifdef::ibm-power-vs[]
40+
.. Log in to IBM Cloud by using the CLI:
41+
+
42+
[source,terminal]
43+
----
44+
$ ibmcloud login
45+
----
46+
endif::ibm-power-vs[]
47+
3548
.. Create the CIS instance:
3649
+
3750
[source,terminal]
@@ -43,12 +56,23 @@ $ ibmcloud cis instance-create <instance_name> standard <1>
4356
. Connect an existing domain to your CIS instance:
4457

4558
.. Set the context instance for CIS:
59+
ifndef::ibm-power-vs[]
4660
+
4761
[source,terminal]
4862
----
4963
$ ibmcloud cis instance-set <instance_name> <1>
5064
----
5165
<1> The instance cloud resource name.
66+
endif::ibm-power-vs[]
67+
ifdef::ibm-power-vs[]
68+
+
69+
[source,terminal]
70+
----
71+
$ ibmcloud cis instance-set <instance_CRN> <1>
72+
----
73+
<1> The instance CRN (Cloud Resource Name).
74+
For example: `ibmcloud cis instance-set crn:v1:bluemix:public:power-iaas:osa21:a/65b64c1f1c29460d8c2e4bbfbd893c2c:c09233ac-48a5-4ccb-a051-d1cfb3fc7eb5::`
75+
endif::ibm-power-vs[]
5276

5377
.. Add the domain for CIS:
5478
+
@@ -65,4 +89,8 @@ A root domain uses the form `openshiftcorp.com`. A subdomain uses the form `clus
6589

6690
. Open the link:https://cloud.ibm.com/catalog/services/internet-services[CIS web console], navigate to the *Overview* page, and note your CIS name servers. These name servers will be used in the next step.
6791

68-
. Configure the name servers for your domains or subdomains at the domain's registrar or DNS provider. For more information, see the IBM Cloud link:https://cloud.ibm.com/docs/cis?topic=cis-getting-started#configure-your-name-servers-with-the-registrar-or-existing-dns-provider[documentation].
92+
. Configure the name servers for your domains or subdomains at the domain's registrar or DNS provider. For more information, see the IBM Cloud link:https://cloud.ibm.com/docs/cis?topic=cis-getting-started#configure-your-name-servers-with-the-registrar-or-existing-dns-provider[documentation].
93+
94+
ifeval::["{context}" == "installing-ibm-cloud-account-power-vs"]
95+
:!ibm-power-vs:
96+
endif::[]

modules/installation-configuration-parameters.adoc

Lines changed: 62 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,27 @@ ifndef::openshift-origin[]
123123
----
124124
endif::[]
125125

126+
ifdef::ibm-power-vs[]
127+
|`platform.powervs.userID`
128+
|The UserID is the login for the user's IBM Cloud account.
129+
|String. For example, `existing_user_id`.
130+
131+
|`platform.powervs.powervsResourceGroup`
132+
|The PowerVSResourceGroup is the resource group in which {ibmpowerProductName} Virtual Server resources are created. If using an existing VPC, the existing VPC and subnets should be in this resource group.
133+
|String. For example, `existing_resource_group`.
134+
135+
|`platform.powervs.region`
136+
|Specifies the IBM Cloud colo region where the cluster will be created.
137+
|String. For example, `existing_region`.
138+
139+
|`platform.powervs.zone`
140+
|Specifies the IBM Cloud colo region where the cluster will be created.
141+
|String. For example, `existing_zone`.
142+
143+
|`platform.powervs.serviceInstanceID`
144+
|The ServiceInstanceID is the ID of the Power IAAS instance created from the IBM Cloud Catalog.
145+
|String. For example, `existing_service_instance_ID`.
146+
endif::ibm-power-vs[]
126147
|====
127148

128149
[id="installation-configuration-parameters-network_{context}"]
@@ -593,6 +614,47 @@ For production {product-title} clusters on which you want to perform installatio
593614
====
594615
a|For example, `sshKey: ssh-ed25519 AAAA..`.
595616

617+
ifdef::ibm-power-vs[]
618+
|`platform.powervs.vpcRegion`
619+
|Specifies the IBM Cloud region in which to create VPC resources.
620+
|String. For example, `existing_vpc_region`.
621+
622+
|`platform.powervs.vpcSubnets`
623+
|Specifies existing subnets (by name) where cluster resources will be created.
624+
|String. For example, `powervs_region_example_subnet`.
625+
626+
|`platform.powervs.vpcName`
627+
|Specifies the IBM Cloud VPC name.
628+
|String. For example, `existing_vpcName`.
629+
630+
|`platform.powervs.cloudConnectionName`
631+
|The CloudConnectionName is the name of an existing PowerVS Cloud connection.
632+
|String. For example, `existing_cloudConnectionName`.
633+
634+
|`platform.powervs.clusterOSImage`
635+
|The ClusterOSImage is a pre-created {ibmpowerProductName} Virtual Server boot image that overrides the default image for cluster nodes.
636+
|String. For example, `existing_cluster_os_image`.
637+
638+
|`platform.powervs.defaultMachinePlatform`
639+
|The DefaultMachinePlatform is the default configuration used when installing on {ibmpowerProductName} Virtual Server for machine pools that do not define their own platform configuration.
640+
|String. For example, `existing_machine_platform`.
641+
642+
|`platform.powervs.memoryGiB`
643+
|The size of a virtual machine's memory, in GB.
644+
|The valid integer must be an integer number of GB that is at least 2 and no more than 64, depending on the machine type.
645+
646+
|`platform.powervs.procType`
647+
|The ProcType defines the processor sharing model for the instance.
648+
|The valid values are Capped, Dedicated, and Shared.
649+
650+
|`platform.powervs.processors`
651+
|The Processors defines the processing units for the instance.
652+
|The number of processors must be from .5 to 32 cores. The processors must be in increments of .25.
653+
654+
|`platform.powervs.sysType`
655+
|The SysType defines the system type for the instance.
656+
|The system type must be either `e980` or `s922`.
657+
endif::ibm-power-vs[]
596658
|====
597659

598660
ifdef::aws[]
@@ -1396,97 +1458,6 @@ In either case, this resource group must only be used for a single cluster insta
13961458
--
13971459
endif::ibm-cloud[]
13981460

1399-
ifdef::ibm-power-vs[]
1400-
[id="installation-configuration-parameters-additional-ibm-cloud_{context}"]
1401-
== Additional {ibmpowerProductName} Virtual Server configuration parameters
1402-
1403-
Additional {ibmpowerProductName} Virtual Server configuration parameters are described in the following table. These parameters can be used for `compute` and `controlPlane`.
1404-
1405-
.Additional {ibmpowerProductName} Virtual Server parameters
1406-
[cols=".^1,.^6a,.^3a",options="header"]
1407-
|====
1408-
|Parameter|Description|Values
1409-
1410-
|`platform.powervs.userID`
1411-
|The UserID is the login for the user's IBM Cloud account.
1412-
|String. For example `existing_user_id`.
1413-
1414-
|`platform.powervs.powervsResourceGroup`
1415-
|The PowerVSResourceGroup is the resource group in which {ibmpowerProductName} Virtual Server resources are created. If using an existing VPC, the existing VPC and subnets should be in this resource group.
1416-
|String. For example `existing_resource_group`.
1417-
1418-
|`platform.powervs.region`
1419-
|Specifies the IBM Cloud colo region where the cluster will be created.
1420-
|String. For example `existing_region`.
1421-
1422-
|`platform.powervs.zone`
1423-
|Specifies the IBM Cloud colo region where the cluster will be created.
1424-
|String. For example `existing_zone`.
1425-
1426-
|`platform.powervs.serviceInstanceID`
1427-
|The ServiceInstanceID is the ID of the Power IAAS instance created from the IBM Cloud Catalog.
1428-
|String. For example `existing_service_instance_ID`.
1429-
1430-
|`platform.powervs.vpcRegion`
1431-
|Specifies the IBM Cloud region in which to create VPC resources.
1432-
|String. For example `existing_vpc_region`.
1433-
1434-
|`platform.powervs.vpcSubnets`
1435-
|Specifies existing subnets (by name) where cluster resources will be created.
1436-
|String. For example `powervs_region_example_subnet`.
1437-
1438-
|`platform.powervs.vpcName`
1439-
|Specifies the IBM Cloud VPC name.
1440-
|String. For example `existing_vpcName`.
1441-
1442-
|`platform.powervs.cloudConnectionName`
1443-
|The CloudConnctionName is the name of an existing PowerVS Cloud connection.
1444-
|String. For example `existing_cloudConnectionName`.
1445-
1446-
|`platform.powervs.clusterOSImage`
1447-
|The ClusterOSImage is a pre-created {ibmpowerProductName} Virtual Server boot image that overrides the default image for cluster nodes.
1448-
|String. For example `existing_cluster_os_image`.
1449-
1450-
|`platform.powervs.defaultMachinePlatform`
1451-
|The DefaultMachinePlatform is the default configuration used when installing on {ibmpowerProductName} Virtual Server for machine pools that do not define their own platform configuration.
1452-
|String. For example `existing_machine_platform`.
1453-
1454-
//|`platform.ibmcloud.dedicatedHosts.profile`
1455-
//|The new dedicated host to create. If you specify a value for `platform.ibmcloud.dedicatedHosts.name`, this parameter is not required.
1456-
//|Valid IBM Cloud VPC dedicated host profile, such as `cx2-host-152x304`. [^2^]
1457-
1458-
//|`platform.ibmcloud.dedicatedHosts.name`
1459-
//|An existing dedicated host. If you specify a value for `platform.ibmcloud.dedicatedHosts.profile`, this parameter is not required.
1460-
//|String, for example `my-dedicated-host-name`.
1461-
1462-
//|`platform.ibmcloud.type`
1463-
//|The instance type for all IBM Cloud VPC machines.
1464-
//|Valid IBM Cloud VPC instance type, such as `bx2-8x32`. [^2^]
1465-
1466-
|`platform.powervs.memoryGiB`
1467-
|The size of a virtual machine's memory, in GB.
1468-
|The valid integer must be an integer number of GB that is at least 2 and no more than 64, depending on the machine type.
1469-
1470-
|`platform.powervs.procType`
1471-
|The ProcType defines the processor sharing model for the instance.
1472-
|The valid values are Capped, Dedicated and Shared.
1473-
1474-
|`platform.powervs.processors`
1475-
|The Processors defines the processing units for the instance.
1476-
|The number of processors must be from .5 to 32 cores. The processors must be in increments of .25.
1477-
1478-
|`platform.powervs.sysType`
1479-
|The SysType defines the system type for the instance.
1480-
|The system type must be either `e980` or `s922`.
1481-
1482-
|====
1483-
[.small]
1484-
--
1485-
1. Whether you define an existing resource group, or if the installer creates one, determines how the resource group is treated when the cluster is uninstalled. If you define a resource group, the installer removes all of the installer-provisioned resources, but leaves the resource group alone; if a resource group is created as part of the installation, the installer removes all of the installer provisioned resources and the resource group.
1486-
2. To determine which profile best meets your needs, see https://cloud.ibm.com/docs/vpc?topic=vpc-profiles&interface=ui[Instance Profiles] in the IBM documentation.
1487-
--
1488-
endif::ibm-power-vs[]
1489-
14901461
ifdef::vsphere[]
14911462

14921463
[id="installation-configuration-parameters-additional-vsphere_{context}"]

modules/installation-initializing.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,15 @@ files that the installation program creates.
263263
When specifying the directory:
264264
* Verify that the directory has the `execute` permission. This permission is required to run Terraform binaries under the installation directory.
265265
* Use an empty directory. Some installation assets, such as bootstrap X.509 certificates, have short expiration intervals, therefore you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier {product-title} version.
266+
+
267+
[NOTE]
268+
=====
269+
Always delete the `~/.powervs` directory to avoid reusing a stale configuration. Run the following command:
270+
[source,terminal]
271+
----
272+
$ rm -rf ~/.powervs
273+
----
274+
=====
266275
.. At the prompts, provide the configuration details for your cloud:
267276
... Optional: Select an SSH key to use to access your cluster machines.
268277
+

0 commit comments

Comments
 (0)