Skip to content

Commit 5d43caa

Browse files
authored
Merge pull request #102161 from EricPonvelle/OSDOCS-16565_ROSA-planning
OSDOCS-16565: Updated Prepare Your Environment for DITA compliance
2 parents d0de0fa + acc6cf3 commit 5d43caa

File tree

75 files changed

+676
-595
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+676
-595
lines changed

.vale.ini

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
StylesPath = .vale/styles
22

3-
MinAlertLevel = suggestion
3+
MinAlertLevel = warning
44

55
Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc, https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
66

77
Vocab = OpenShiftDocs
88

99
# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
10-
[[!.]*.adoc]
11-
BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc
10+
[*.adoc]
11+
BasedOnStyles = AsciiDocDITA
1212

1313
# Disabling rules (NO)
1414
RedHat.ReleaseNotes = NO
@@ -19,26 +19,16 @@ Vale.Avoid = YES
1919

2020
# Enable specifc DITA rules on assemblies
2121
AsciiDocDITA.AdmonitionTitle = error
22-
AsciiDocDITA.AuthorLine = error
23-
AsciiDocDITA.BlockTitle = error
24-
AsciiDocDITA.CalloutList = error
25-
AsciiDocDITA.ContentType = error
26-
AsciiDocDITA.DiscreteHeading = error
27-
AsciiDocDITA.EntityReference = error
28-
AsciiDocDITA.EquationFormula = error
29-
AsciiDocDITA.ExampleBlock = error
30-
AsciiDocDITA.LineBreak = error
31-
AsciiDocDITA.NestedSection = error
22+
AsciiDocDITA.ThematicBreak = error
23+
AsciiDocDITA.TableFooter = error
3224
AsciiDocDITA.PageBreak = error
33-
AsciiDocDITA.RelatedLinks = error
34-
AsciiDocDITA.ShortDescription = error
25+
AsciiDocDITA.DiscreteHeading = error
3526
AsciiDocDITA.SidebarBlock = error
36-
AsciiDocDITA.TableFooter = error
37-
AsciiDocDITA.TaskDuplicate = error
27+
AsciiDocDITA.LineBreak = error
28+
AsciiDocDITA.EquationFormula = error
3829
AsciiDocDITA.TaskExample = error
39-
AsciiDocDITA.TaskSection = error
40-
AsciiDocDITA.TaskStep = error
41-
AsciiDocDITA.ThematicBreak = error
30+
AsciiDocDITA.EntityReference = error
31+
AsciiDocDITA.ExampleBlock = error
4232

4333
# Disable module specific rules
4434
OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = NO

modules/ccs-aws-provisioned.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Two buckets are required with a typical size of 2 TB each.
6464
== VPC
6565
Customers should expect to see one VPC per cluster. Additionally, the VPC needs the following configurations:
6666

67-
include::snippets/install-cluster-in-vpc.adoc[]
67+
include::snippets/snip_install-cluster-in-vpc.adoc[]
6868

6969
* *Subnets*: Two subnets for a cluster with a single availability zone, or six subnets for a cluster with multiple availability zones.
7070
+

modules/ccs-gcp-provisioned.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This is an overview of the provisioned {gcp-first} components on a deployed {pro
3636
[id="gcp-policy-vpc_{context}"]
3737
== VPC
3838

39-
include::snippets/install-cluster-in-vpc.adoc[]
39+
include::snippets/snip_install-cluster-in-vpc.adoc[]
4040

4141
* **Subnets:** One master subnet for the control plane workloads and one worker subnet for all others. An additional subnet is required for Google Private Service Connect (PSC) when a private cluster is deployed using PSC.
4242
* **Router tables:** One global route table per VPC.

modules/create-wif-cluster-ocm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ For more information about custom application ingress settings, click on the inf
156156
. Optional: To install the cluster into a {gcp-short} Shared VPC, follow these steps.
157157
+
158158
--
159-
include::snippets/install-cluster-in-vpc.adoc[]
159+
include::snippets/snip_install-cluster-in-vpc.adoc[]
160160
161161
[IMPORTANT]
162162
====
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="mos-checklist-accounts_{context}"]
6+
= Accounts and permissions
7+
8+
[role="_abstract"]
9+
Ensure that you have the following accounts, credentials, and permissions.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="mos-checklist-add-custom-sgs_{context}"]
6+
= Additional custom security groups
7+
8+
[role="_abstract"]
9+
During cluster creation, you can add additional custom security groups to a cluster that has an existing non-managed VPC. To do so, complete these prerequisites before you create the cluster:
10+
11+
* Create the custom security groups in AWS before you create the cluster.
12+
* Associate the custom security groups with the VPC that you are using to create the cluster. Do not associate the custom security groups with any other VPC.
13+
* You may need to request additional AWS quota for `Security groups per network interface`.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="mos-checklist-aws-account_{context}"]
6+
= AWS account
7+
8+
[role="_abstract"]
9+
You must have an AWS account with certain permissions before creating your cluster.
10+
11+
* Create an AWS account if you do not already have one.
12+
* Gather the credentials required to log in to your AWS account.
13+
* Ensure that your AWS account has sufficient permissions to use the {rosa-cli}.
14+
//OSDOCS-11789: Moving these here because it is a permission / account level enablement
15+
* Enable {product-title} for your AWS account on the link:https://console.aws.amazon.com/rosa/[AWS console].
16+
** If your account is the management account for your organization (used for AWS billing purposes), you must have `aws-marketplace:Subscribe` permissions available on your account. See _Service control policy (SCP) prerequisites_ for more information, or see the AWS documentation for troubleshooting: link:https://docs.aws.amazon.com/rosa/latest/userguide/security-iam-troubleshoot.html#error-aws-orgs-scp-denies-permissions[AWS Organizations service control policy denies required AWS Marketplace permissions].
17+
* Ensure you have not enabled restrictive tag policies. For more information, see link:https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html[Tag policies] in the AWS documentation.

modules/mos-checklist-aws-cli.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="mos-checklist-aws-cli_{context}"]
6+
= AWS CLI (`aws`)
7+
8+
[role="_abstract"]
9+
The AWS CLI tool allows you to interact with AWS resources directly.
10+
11+
.Procedure
12+
. Install the link:https://aws.amazon.com/cli/[AWS Command Line Interface].
13+
. Log in to your AWS account using the AWS CLI: link:https://docs.aws.amazon.com/signin/latest/userguide/command-line-sign-in.html[Sign in through the AWS CLI]
14+
. Verify your account identity:
15+
+
16+
[source,terminal]
17+
----
18+
$ aws sts get-caller-identity
19+
----
20+
. Check whether the service role for ELB (Elastic Load Balancing) exists:
21+
+
22+
[source,terminal]
23+
----
24+
$ aws iam get-role --role-name "AWSServiceRoleForElasticLoadBalancing"
25+
----
26+
+
27+
If the role does not exist, create it by running the following command:
28+
+
29+
[source,terminal]
30+
----
31+
$ aws iam create-service-linked-role --aws-service-name "elasticloadbalancing.amazonaws.com"
32+
----
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="mos-checklist-aws-infra-prereqs_{context}"]
6+
//TODO OSDOCS-11789: Moved quota check to the point where it is actually useful - yes, this is checked during install, but it's also worth checking ahead of time so that any issues are known during preparation rather than deployment.
7+
= AWS infrastructure prerequisites
8+
9+
[role="_abstract"]
10+
Before you create your cluster, you need to have sufficient AWS quota.
11+
12+
.Procedure
13+
* To verify that your AWS account has sufficient quota available to deploy a cluster, run the following command:
14+
+
15+
[source,terminal]
16+
----
17+
$ rosa verify quota
18+
----
19+
+
20+
This command only checks the total quota allocated to your account; it does not reflect the amount of quota already consumed from that quota. Running this command is optional because your quota is verified during cluster deployment. However, Red{nbsp}Hat recommends running this command to confirm your quota ahead of time so that deployment is not interrupted by issues with quota availability.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-cloud-expert-prereq-checklist.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="mos-checklist-cli-requirements_{context}"]
6+
= CLI requirements
7+
8+
[role="_abstract"]
9+
You need to download and install several CLI (command-line interface) tools to be able to deploy a cluster.

0 commit comments

Comments
 (0)