1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/rosa-initialize.adoc
2025-11-05 19:06:33 +00:00

92 lines
2.5 KiB
Plaintext

// Module included in the following assemblies:
//
// * rosa_cli/rosa-get-started-cli.adoc
:_mod-docs-content-type: REFERENCE
[id="rosa-initialize_{context}"]
= Initializing {product-title}
Use the `init` command to initialize {product-title} only if you are using non-STS.
[id="rosa-init_{context}"]
== init
Perform a series of checks to verify that you are ready to deploy a {product-title} cluster.
The list of checks includes the following:
* Checks to see that you have logged in (see `login`)
* Checks that your AWS credentials are valid
* Checks that your AWS permissions are valid (see `verify permissions`)
* Checks that your AWS quota levels are high enough (see `verify quota`)
* Runs a cluster simulation to ensure cluster creation will perform as expected
* Checks that the `osdCcsAdmin` user has been created in your AWS account
* Checks that the OpenShift Container Platform command-line tool is available on your system
.Syntax
[source,terminal]
----
$ rosa init [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--region
|The AWS region (string) in which to verify quota and permissions. This value overrides the `AWS_REGION` environment variable only when running the `init` command, but it does not change your AWS CLI configuration.
|--delete
|Deletes the stack template that is applied to your AWS account during the `init` command.
|--client-id
|The OpenID client identifier (string). Default: `cloud-services`
|--client-secret
|The OpenID client secret (string).
|--insecure
|Enables insecure communication with the server. This disables verification of TLS certificates and host names.
|--scope
|The OpenID scope (string). If this option is used, it completely replaces the default scopes. This can be repeated multiple times to specify multiple scopes. Default: `openid`
|--token
|Accesses or refreshes the token (string).
|--token-url
|The OpenID token URL (string). Default: `\https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token`
|===
.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition
|--help
|Shows help for this command.
|--debug
|Enables debug mode.
|--profile
|Specifies an AWS profile (string) from your credentials file.
|===
.Examples
Configure your AWS account to allow ROSA clusters:
[source,terminal]
----
$ rosa init
----
Configure a new AWS account using pre-existing {cluster-manager} credentials:
[source,terminal]
----
$ rosa init --token=$OFFLINE_ACCESS_TOKEN
----