Skip to content

Commit 9872e65

Browse files
bmcelveebmcelvee
authored
Merge pull request #91002 from mletalie/OSDOCS-13755
[OSDOCS-13755] ROSA docs for editing billing account
2 parents 79164b1 + 6b085a3 commit 9872e65

File tree

6 files changed

+74
-7
lines changed

6 files changed

+74
-7
lines changed

‎_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,8 @@ Topics:
324324
File: rosa-checking-logs-cli
325325
- Name: Least privilege permissions for ROSA CLI commands
326326
File: rosa-cli-permission-examples
327+
- Name: Managing AWS billing accounts with the ROSA CLI
328+
File: rosa-updating-billing-account-cli
327329
---
328330
Name: Red Hat OpenShift Cluster Manager
329331
Dir: ocm

‎cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/attributes-openshift-dedicated.adoc[]
3+
[id="rosa-updating-account-cli"]
4+
= Managing billing accounts for ROSA with HCP clusters
5+
:context: rosa-updating-account-cli
6+
toc::[]
7+
8+
9+
You can use the ROSA CLI (`rosa`) to link your cluster to the desired AWS billing account after the cluster has been deployed.
10+
11+
This can be useful if you have accidentally linked to the wrong AWS billing account during cluster deployment, or if you simply want to update the billing account.
12+
13+
[NOTE]
14+
====
15+
You also have the option to update your billing account through the {cluster-manager}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts for OpenShift Service on AWS Hosted Control Planes clusters.]
16+
====
17+
18+
19+
include::modules/rosa-update-billing-cli.adoc[leveloffset=+1]
20+

‎modules/rosa-edit-objects.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ $ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
3939

4040
|--enable-delete-protection=false
4141
|Disables the delete protection feature.
42-
42+
ifdef::openshift-rosa-hcp[]
43+
|--billing-account-string
44+
|Specifies the account used for billing subscriptions purchased from the AWS marketplace.
45+
endif::openshift-rosa-hcp[]
4346

4447
|===
4548

@@ -204,7 +207,7 @@ a|-c, --cluster <cluster_name>\|<cluster_id>
204207
|Enable interactive mode.
205208

206209
|--pod-pids-limit <number>
207-
a|Required. The maximum number of PIDs for each node in the
210+
a|Required. The maximum number of PIDs for each node in the
208211
ifdef::temp-ifdef[]
209212
cluster.
210213
endif::[]
@@ -213,7 +216,7 @@ machine pool associated with the `KubeletConfig` object.
213216
endif::[]
214217

215218
|--name
216-
a|
219+
a|
217220
ifdef::temp-ifdef[]
218221
Optional.
219222
endif::[]

‎modules/rosa-update-billing-cli.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * * rosa_cli/rosa-updating-billing-account-cli.adoc
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="rosa-update-billing_{context}"]
6+
= Update billing accounts for ROSA with HCP clusters
7+
8+
.Prerequisites
9+
10+
* You must have more than one AWS billing account.
11+
* The AWS billing account you want your cluster to link to must already be linked to the Red{nbsp}Hat organization where the cluster is deployed.
12+
13+
14+
.Procedure
15+
. Run the following command in your terminal window:
16+
17+
+
18+
19+
.Syntax
20+
[source,terminal]
21+
----
22+
$ rosa edit cluster -c <cluster_ID> <1>
23+
----
24+
<1> Replace `<cluster_ID>` with the ID of the cluster that you want to update the AWS billing account.
25+
26+
+
27+
[NOTE]
28+
====
29+
To locate the IDs of your active clusters, run the `$ rosa list clusters` command in your terminal window.
30+
====
31+
32+
+
33+
34+
. Skip to the `Billing Account` parameter within the interactive mode.
35+
36+
. Select the desired AWS billing account from the list of available options and press "Enter".
37+
38+
+
39+
40+
The AWS billing account for your cluster is now updated.

‎ocm/ocm-overview.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ You can use {cluster-manager} to do the following actions:
1717
* Manage access control
1818
* Monitor clusters
1919
* Schedule upgrades
20+
ifdef::openshift-rosa-hcp[]
21+
* Update billing accounts
22+
endif::openshift-rosa-hcp[]
2023
2124
For more information about {cluster-manager}, see the entire link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index[{cluster-manager} documentation].
2225

‎rosa_release_notes/rosa-release-notes.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ endif::openshift-rosa[]
3737
** Configure a `cluster-admin` user and optionally define a custom password.
3838
** Configure the root disk size for the default machine pool.
3939

40-
ifdef::openshift-rosa-hcp[]
41-
* **Edit the billing account for existing ROSA with HCP clusters.** You can now update the billing account associated with your {hcp-title} clusters after cluster creation. For more information, see the {cluster-manager} documentation: link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts].
42-
endif::openshift-rosa-hcp[]
43-
4440
//The following is included in Classic only until the Images doc has been split for HCP
4541
ifndef::openshift-rosa-hcp[]
4642
* **Image configuration is now available for {hcp-title}.** You can configure registries within a cluster to exclude some registries or allow only a defined list. It also allows to expose additional trusted bundle for registries to pull from. For more information, see xref:../openshift_images/image-configuration-hcp.adoc#images-configuration-parameters-hcp_image-configuration-hcp[Image configuration resources for {hcp-title}].
@@ -90,6 +86,8 @@ ifdef::openshift-rosa[]
9086

9187
* **Configure machine pool disk volume for {hcp-title} clusters.** You can now configure the disk volume size for machine pools in {hcp-title} clusters. The default disk size is 300 GiB, and you can configure it from a minimum of 75 GiB to a maximum of 16,384 GiB. For more information, see xref:../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#configuring-machine-pool-disk-volume_rosa-managing-worker-nodes[Configuring machine pool disk volume].
9288

89+
* **Edit the billing account for existing ROSA with HCP clusters.** You can now update the billing account associated with your {hcp-title} clusters after cluster creation. For more information, see the {cluster-manager} documentation: link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts for OpenShift Service on AWS Hosted Control Planes clusters].
90+
9391
[id="rosa-q3-2024_{context}"]
9492
=== Q3 2024
9593

@@ -200,6 +198,7 @@ endif::openshift-rosa-hcp[]
200198

201199
* **{VirtProductName} support.** The release of {VirtProductName} 4.14 added support for running {VirtProductName} on ROSA Classic clusters. For more information, see link:https://docs.openshift.com/container-platform/4.14/virt/install/preparing-cluster-for-virt.html#virt-aws-bm_preparing-cluster-for-virt[{VirtProductName} on AWS bare metal] in the {OCP} documentation.
202200

201+
203202
[id="rosa-q3-2023_{context}"]
204203
=== Q3 2023
205204

0 commit comments

Comments
 (0)