Skip to content

Commit c684f5c

Browse files
cadawsoncadawson
authored
Merge pull request #682 from open-cluster-management/dawson2363100
Dawson2363100
2 parents 7651a5e + fae60c1 commit c684f5c

16 files changed

+207
-229
lines changed

‎manage_applications/managing_deployables.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ To update a deployable with a new version, you can change the deployed resource
6464
6565
1. Run the following command against the source deployable:
6666
67-
```
68-
kubectl edit deployables.app.ibm.com <deployableName>
69-
```
67+
```
68+
kubectl edit deployables.app.ibm.com <deployableName>
69+
```
7070
7171
2. Update any fields or annotations that you need to change.
7272

‎manage_cluster/bare_assets.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ Bare metal assets are virtual or physical servers that are configured to run you
44

55
You must create a bare metal asset in Red Hat Advanced Cluster Management for Kubernetes to create a cluster on it. Use the following procedure to create a bare metal asset that can host a cluster that is managed by Red Hat Advanced Cluster Management for Kubernetes.
66

7-
- [Prerequisites](#bma-prerequisites)
8-
- [Creating your bare metal asset with the console](#creating-a-bare-metal-asset-with-the-console)
9-
- [Modifying a bare metal asset](#modifying-a-bare-metal-asset)
10-
- [Removing a bare metal asset](#removing-a-bare-metal-asset)
11-
127
## Prerequisites {#bma-prerequisites}
138

149
You need the following prerequisites before creating a bare metal asset:
@@ -19,10 +14,11 @@ You need the following prerequisites before creating a bare metal asset:
1914

2015
* A configured bare metal asset, and log in credentials with the required permissions to log in and manage it.
2116
**Note:** Login credentials for your bare metal asset include the following items for the asset that are provided by your administrator:
22-
* user name
23-
* password
24-
* Baseboard Management Controller Address
25-
* boot NIC MAC address
17+
18+
* user name
19+
* password
20+
* Baseboard Management Controller Address
21+
* boot NIC MAC address
2622

2723
## Creating a bare metal asset with the console {#creating-a-bare-metal-asset-with-the-console}
2824

@@ -39,10 +35,10 @@ To create a bare metal asset using the Red Hat Advanced Cluster Management for K
3935
4. Enter the namespace where you want to create the bare metal asset. Users who have access to this namespace can associate this asset to the cluster when creating a cluster.
4036

4137
5. Enter the Baseboard Management Conroller address. This is the controller that enables communication with the host. The following protocols are supported:
42-
* IPMI, see [IPMI 2.0 Specification](https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html) for more information.
43-
* iDRAC, see [Support for Integrated Dell Remote Access Controller 9 (iDRAC9)](https://www.dell.com/support/article/en-us/sln311300/support-for-integrated-dell-remote-access-controller-9-idrac9?lang=en) for more information.
44-
* iRMC, see [Data Sheet: FUJITSU Software ServerView Suite integrated Remote Management Controller - iRMC S5](https://sp.ts.fujitsu.com/dmsp/Publications/public/ds-irmc-s5-en.pdf) for more information.
45-
* Redfish, see [Redfish specification](https://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.8.0.pdf) for more information.
38+
* IPMI, see [IPMI 2.0 Specification](https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html) for more information.
39+
* iDRAC, see [Support for Integrated Dell Remote Access Controller 9 (iDRAC9)](https://www.dell.com/support/article/en-us/sln311300/support-for-integrated-dell-remote-access-controller-9-idrac9?lang=en) for more information.
40+
* iRMC, see [Data Sheet: FUJITSU Software ServerView Suite integrated Remote Management Controller - iRMC S5](https://sp.ts.fujitsu.com/dmsp/Publications/public/ds-irmc-s5-en.pdf) for more information.
41+
* Redfish, see [Redfish specification](https://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.8.0.pdf) for more information.
4642

4743
6. Enter the user name and password for the bare metal asset.
4844

‎manage_cluster/create_azure.md‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@
22

33
You can use the Red Hat Advanced Cluster Management for Kubernetes console to deploy a Red Hat OpenShift Container Platform cluster on Microsoft Azure.
44

5-
- [Prerequisites](#azure_prerequisites)
6-
- [Creating your cluster with the Red Hat Advanced Cluster Management for Kubernetes console](#azure_creating-your-cluster-with-the-red-hat-advanced-cluster-management-for-kubernetes-console)
7-
- [Accessing your cluster](#azure_accessing-your-cluster)
8-
- [Removing a cluster from management](#azure_removing-a-cluster-from-management)
9-
105
## Prerequisites {#azure_prerequisites}
116

127
You must have the following prerequisites before creating a cluster on Azure:
@@ -35,11 +30,11 @@ To create clusters from the Red Hat Advanced Cluster Management for Kubernetes c
3530

3631
3. Select **Create a cluster**.
3732

38-
**Note:** This procedure is for creating a cluster. If you have an existing cluster that you want to import, see [Importing a target managed cluster to the hub cluster](import.md) for those steps.
33+
**Note:** This procedure is for creating a cluster. If you have an existing cluster that you want to import, see [Importing a target managed cluster to the hub cluster](import.md) for those steps.
3934

4035
4. Enter a name for your cluster. This name is used in the hostname of the cluster.
4136

42-
**Tip:** You can view the `yaml` content updates as you enter the information in the console by setting the *YAML* switch to **ON**.
37+
**Tip:** You can view the `yaml` content updates as you enter the information in the console by setting the *YAML* switch to **ON**.
4338

4439
5. Enter the base domain information that you configured for your Azure account. See [Configuring a custom domain name for an Azure cloud service](https://docs.microsoft.com/en-us/azure/cloud-services/cloud-services-custom-domain-name-portal) for more information. This name is used in the hostname of the cluster.
4540

@@ -51,13 +46,13 @@ To create clusters from the Red Hat Advanced Cluster Management for Kubernetes c
5146

5247
9. Configure the *Node pools* for your cluster.
5348

54-
The node pools define the location and size of the nodes that are used for your cluster.
49+
The node pools define the location and size of the nodes that are used for your cluster.
5550

56-
The *Region* specifies where the nodes are located geographically. A closer region might provide faster performance, but a more distant region might be more distributed.
51+
The *Region* specifies where the nodes are located geographically. A closer region might provide faster performance, but a more distant region might be more distributed.
5752

58-
* Master pool: There are three Master nodes that are created for your cluster in the master pool. The master nodes share the management of the cluster activity. You can select multiple zones within the region for a more distributed group of master nodes. You can change the type and size of your instance after it is created, but you can also specify it in this section. The default values are *Standard_D2s_v3 - 2 vCPU, 8 GiB RAM - General Purpose* with 512 GiB of root storage.
53+
* Master pool: There are three Master nodes that are created for your cluster in the master pool. The master nodes share the management of the cluster activity. You can select multiple zones within the region for a more distributed group of master nodes. You can change the type and size of your instance after it is created, but you can also specify it in this section. The default values are *Standard_D2s_v3 - 2 vCPU, 8 GiB RAM - General Purpose* with 512 GiB of root storage.
5954

60-
* Worker pools: You can create one or more worker nodes in a worker pool to run the container workloads for the cluster. They can be in a single worker pool, or distributed across multiple worker pools.
55+
* Worker pools: You can create one or more worker nodes in a worker pool to run the container workloads for the cluster. They can be in a single worker pool, or distributed across multiple worker pools.
6156

6257
10. **Optional:** Configure the cluster networking options.
6358

@@ -83,7 +78,7 @@ To access a cluster that is managed by Red Hat Advanced Cluster Management for K
8378

8479
7. Select **Launch to cluster**.
8580

86-
**Tip:** If you already know the log in credentials, you can access the cluster by selecting the *Actions* menu for the cluster, and selecting **Launch to cluster**.
81+
**Tip:** If you already know the log in credentials, you can access the cluster by selecting the *Actions* menu for the cluster, and selecting **Launch to cluster**.
8782

8883
## Removing a cluster from management {#azure_removing-a-cluster-from-management}
8984

@@ -99,4 +94,4 @@ Destroying a cluster removes it from management and deletes the components of th
9994

10095
3. Select **Destroy cluster** or **Detach cluster**.
10196

102-
**Tip:** You can detach or destroy multiple clusters by selecting the check boxes of the clusters that you want to detach or destroy. Then select **Detach** or **Destroy**.
97+
**Tip:** You can detach or destroy multiple clusters by selecting the check boxes of the clusters that you want to detach or destroy. Then select **Detach** or **Destroy**.

‎manage_cluster/create_bare.md‎

Lines changed: 38 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@
22

33
You can use the Red Hat Advanced Cluster Management for Kubernetes console to create a Red Hat OpenShift Container Platform cluster in a bare metal environment.
44

5-
- [Prerequisites](#bare_prerequisites)
6-
- [Creating your cluster with the Red Hat Advanced Cluster Management for Kubernetes console](#bare_creating-your-cluster-with-the-red-hat-advanced-cluster-management-for-kubernetes-console)
7-
- [Accessing your cluster](#bare_accessing-your-cluster)
8-
- [Removing a cluster from management](#bare_removing-a-cluster-from-management)
9-
105
## Prerequisites {#bare_prerequisites}
116

127
You need the following prerequisites before creating a cluster in a bare metal environment:
@@ -23,50 +18,51 @@ You need the following prerequisites before creating a cluster in a bare metal e
2318

2419
* Enable the bare metal feature flag to view the bare metal options. The bare metal selections and options are hidden by a feature flag by default. You can enable the feature flags by completing the following steps:
2520

26-
1. Start the OpenShift command line interface
21+
1. Start the OpenShift command line interface.
2722

2823
2. Edit the `consoleui` deployment resource to modify the settings:
2924

30-
```
31-
MY_CONSOLEUI=`oc -n open-cluster-management get deploy -o name | grep consoleui`
32-
oc edit $MY_CONSOLEUI
33-
```
25+
```
26+
MY_CONSOLEUI=`oc -n open-cluster-management get deploy -o name | grep consoleui`
27+
oc edit $MY_CONSOLEUI
28+
```
3429
3530
3. Change the feature flag setting to *true*. Your update should look like the following example:
3631
37-
```
38-
spec:
39-
...
40-
template:
41-
...
42-
spec:
43-
...
44-
containers:
45-
- env: # Search for env:
46-
- featureFlags_baremetal: "true"
47-
...
48-
```
32+
```
33+
spec:
34+
...
35+
template:
36+
...
37+
spec:
38+
...
39+
containers:
40+
- env: # Search for env:
41+
- featureFlags_baremetal: "true"
42+
...
43+
```
4944
4. Edit the `consoleui` deployment resource to modify the settings:
5045
51-
```
52-
MY_HEADER=`oc -n open-cluster-management get deploy -o name | grep header`
53-
oc edit $MY_HEADER
54-
```
46+
```
47+
MY_HEADER=`oc -n open-cluster-management get deploy -o name | grep header`
48+
oc edit $MY_HEADER
49+
```
5550
5651
5. Change the feature flag setting to *true*. Your update should look like the following example:
5752
58-
```
59-
spec:
60-
...
61-
template:
62-
...
63-
spec:
64-
...
65-
containers:
66-
- env: # Search for env:
67-
- featureFlags_baremetal: "true"
68-
...
69-
```
53+
```
54+
spec:
55+
...
56+
template:
57+
...
58+
spec:
59+
...
60+
containers:
61+
- env: # Search for env:
62+
- featureFlags_baremetal: "true"
63+
...
64+
```
65+
7066
## Creating your cluster with the Red Hat Advanced Cluster Management for Kubernetes console {#bare_creating-your-cluster-with-the-red-hat-advanced-cluster-management-for-kubernetes-console}
7167
7268
To create clusters from the Red Hat Advanced Cluster Management for Kubernetes console, complete the following steps:
@@ -77,11 +73,11 @@ To create clusters from the Red Hat Advanced Cluster Management for Kubernetes c
7773
7874
3. Select **Create a cluster**.
7975
80-
**Note:** This procedure is for creating a cluster. If you have an existing cluster that you want to import, see [Importing a target managed cluster to the hub cluster](import.md) for those steps.
76+
**Note:** This procedure is for creating a cluster. If you have an existing cluster that you want to import, see [Importing a target managed cluster to the hub cluster](import.md) for those steps.
8177
8278
4. Enter a name for your cluster. This name is used in the hostname of the cluster.
8379
84-
**Tip:** You can view the `yaml` content updates as you enter the information in the console by setting the *YAML* switch to **ON**.
80+
**Tip:** You can view the `yaml` content updates as you enter the information in the console by setting the *YAML* switch to **ON**.
8581
8682
5. Enter the base domain information that you configured in your bare metal environment. This name is used in the hostname of the cluster.
8783
@@ -119,7 +115,7 @@ To access a cluster that is managed by Red Hat Advanced Cluster Management for K
119115
120116
7. Select **Launch to cluster**.
121117
122-
**Tip:** If you already know the log in credentials, you can access the cluster by selecting the *Actions* menu for the cluster, and selecting **Launch to cluster**.
118+
**Tip:** If you already know the log in credentials, you can access the cluster by selecting the *Actions* menu for the cluster, and selecting **Launch to cluster**.
123119
124120
## Removing a cluster from management {#bare_removing-a-cluster-from-management}
125121
@@ -135,4 +131,4 @@ Destroying a cluster removes it from management and deletes the components of th
135131
136132
3. Select **Destroy cluster** or **Detach cluster**.
137133
138-
**Tip:** You can detach or destroy multiple clusters by selecting the check boxes of the clusters that you want to detach or destroy. Then select **Detach** or **Destroy**.
134+
**Tip:** You can detach or destroy multiple clusters by selecting the check boxes of the clusters that you want to detach or destroy. Then select **Detach** or **Destroy**.

‎manage_cluster/create_google.md‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
Follow the procedure to create a Red Hat OpenShift Container Platform cluster on Google Cloud Platform (GCP). For more information about Google Cloud Platform, see [Google Cloud Platform](https://cloud.google.com/docs/overview).
44
{:shortdesc}
55

6-
- [Prerequisites](#google_prerequisites)
7-
- [Creating your cluster with the Red Hat Advanced Cluster Management for Kubernetes console](#google_creating-your-cluster-with-the-red-hat-advanced-cluster-management-for-kubernetes-console)
8-
- [Accessing your cluster](#google_accessing-your-cluster)
9-
- [Removing a cluster from management](#google_removing-a-cluster-from-management)
10-
116
## Prerequisites {#google_prerequisites}
127

138
You must have the following prerequisites before creating a cluster on GCP:
@@ -34,11 +29,11 @@ To create clusters from the Red Hat Advanced Cluster Management for Kubernetes c
3429

3530
3. Select **Create a cluster**.
3631

37-
**Note:** This procedure is for creating a cluster. If you have an existing cluster that you want to import, see [Importing a target managed cluster to the hub cluster](import.md) for those steps.
32+
**Note:** This procedure is for creating a cluster. If you have an existing cluster that you want to import, see [Importing a target managed cluster to the hub cluster](import.md) for those steps.
3833

3934
4. Enter a name for your cluster. This name is used in the hostname of the cluster.
4035

41-
**Tip:** You can view the `yaml` content updates as you enter the information in the console by setting the *YAML* switch to **ON**.
36+
**Tip:** You can view the `yaml` content updates as you enter the information in the console by setting the *YAML* switch to **ON**.
4237

4338
5. Enter the base domain information that you configured for your Azure account. See [Setting up a custom domain](https://cloud.google.com/endpoints/docs/openapi/dev-portal-setup-custom-domain) for more information. This name is used in the hostname of the cluster.
4439

@@ -50,13 +45,13 @@ To create clusters from the Red Hat Advanced Cluster Management for Kubernetes c
5045

5146
9. Configure the *Node pools* for your cluster.
5247

53-
The node pools define the location and size of the nodes that are used for your cluster.
48+
The node pools define the location and size of the nodes that are used for your cluster.
5449

55-
The *Region* specifies where the nodes are located geographically. A closer region might provide faster performance, but a more distant region might be more distributed.
50+
The *Region* specifies where the nodes are located geographically. A closer region might provide faster performance, but a more distant region might be more distributed.
5651

57-
* Master pool: There are three Master nodes that are created for your cluster in the master pool. The master nodes share the management of the cluster activity. You can select multiple zones within the region for a more distributed group of master nodes. You can change the type and size of your instance after it is created, but you can also specify it in this section. The default values are *n1-standard-1 - n1-standard-1 1 vCPU - General Purpose* with 500 GiB of root storage.
52+
* Master pool: There are three Master nodes that are created for your cluster in the master pool. The master nodes share the management of the cluster activity. You can select multiple zones within the region for a more distributed group of master nodes. You can change the type and size of your instance after it is created, but you can also specify it in this section. The default values are *n1-standard-1 - n1-standard-1 1 vCPU - General Purpose* with 500 GiB of root storage.
5853

59-
* Worker pools: You can create one or more worker nodes in a worker pool to run the container workloads for the cluster. They can be in a single worker pool, or distributed across multiple worker pools.
54+
* Worker pools: You can create one or more worker nodes in a worker pool to run the container workloads for the cluster. They can be in a single worker pool, or distributed across multiple worker pools.
6055

6156
10. **Optional:** Configure the cluster networking options.
6257

@@ -82,7 +77,7 @@ To access a cluster that is managed by Red Hat Advanced Cluster Management for K
8277

8378
7. Select **Launch to cluster**.
8479

85-
**Tip:** If you already know the log in credentials, you can access the cluster by selecting the *Actions* menu for the cluster, and selecting **Launch to cluster**.
80+
**Tip:** If you already know the log in credentials, you can access the cluster by selecting the *Actions* menu for the cluster, and selecting **Launch to cluster**.
8681

8782
## Removing a cluster from management {#google_removing-a-cluster-from-management}
8883

@@ -98,4 +93,4 @@ Destroying a cluster removes it from management and deletes the components of th
9893

9994
3. Select **Destroy cluster** or **Detach cluster**.
10095

101-
**Tip:** You can detach or destroy multiple clusters by selecting the check boxes of the clusters that you want to detach or destroy. Then select **Detach** or **Destroy**.
96+
**Tip:** You can detach or destroy multiple clusters by selecting the check boxes of the clusters that you want to detach or destroy. Then select **Detach** or **Destroy**.

0 commit comments

Comments
 (0)