mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
96 lines
7.4 KiB
Plaintext
96 lines
7.4 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="rosa-getting-started"]
|
|
= Comprehensive guide to getting started with {product-title}
|
|
include::_attributes/attributes-openshift-dedicated.adoc[]
|
|
:context: rosa-getting-started
|
|
|
|
toc::[]
|
|
|
|
[NOTE]
|
|
====
|
|
If you are looking for a quickstart guide for ROSA, see xref:../rosa_getting_started/rosa-quickstart-guide-ui.adoc#rosa-quickstart-guide-ui[{product-title} quickstart guide].
|
|
====
|
|
|
|
Follow this getting started document to create a {product-title} (ROSA) cluster, grant user access, deploy your first application, and learn how to revoke user access and delete your cluster.
|
|
|
|
You can create a ROSA cluster either with or without the AWS Security Token Service (STS). The procedures in this document enable you to create a cluster that uses AWS STS. For more information about using AWS STS with ROSA clusters, see xref:../rosa_architecture/rosa-understanding.adoc#rosa-understanding-aws-sts_rosa-understanding[Using the AWS Security Token Service].
|
|
|
|
[id="rosa-getting-started-prerequisites_{context}"]
|
|
== Prerequisites
|
|
|
|
* You reviewed the xref:../rosa_architecture/rosa-understanding.adoc#rosa-understanding[introduction to {product-title} (ROSA)], and the documentation on ROSA xref:../architecture/rosa-architecture-models.adoc#rosa-architecture-models[architecture models] and xref:../architecture/architecture.adoc#architecture[architecture concepts].
|
|
|
|
* You have read the documentation on the xref:../rosa_planning/rosa-planning-environment.adoc#rosa-planning-environment[guidelines for planning your environment].
|
|
// Removed as part of OSDOCS-13310, until figures are verified.
|
|
//xref:../rosa_planning/rosa-limits-scalability.adoc#rosa-limits-scalability[limits and scalability] and
|
|
|
|
* You have reviewed the detailed xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
|
|
|
|
* You have the xref:../rosa_planning/rosa-sts-required-aws-service-quotas.adoc#rosa-sts-required-aws-service-quotas[AWS service quotas that are required to run a ROSA cluster].
|
|
|
|
include::modules/rosa-getting-started-environment-setup.adoc[leveloffset=+1]
|
|
include::modules/rosa-getting-started-enable-rosa.adoc[leveloffset=+2]
|
|
include::modules/rosa-getting-started-install-configure-cli-tools.adoc[leveloffset=+2]
|
|
|
|
[id="rosa-getting-started-creating-a-cluster"]
|
|
== Creating a ROSA cluster with STS
|
|
|
|
Choose from one of the following methods to deploy a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS). In each scenario, you can deploy your cluster by using {cluster-manager-first} or the ROSA CLI (`rosa`):
|
|
|
|
* xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[*Creating a ROSA cluster with STS using the default options*]: You can create a ROSA cluster with STS quickly by using the default options and automatic STS resource creation.
|
|
|
|
* xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-a-cluster-with-customizations[*Creating a ROSA cluster with STS using customizations*]: You can create a ROSA cluster with STS using customizations. You can also choose between the `auto` and `manual` modes when creating the required STS resources.
|
|
|
|
.Additional resources
|
|
|
|
* For detailed steps to deploy a ROSA cluster without STS, see xref:../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-creating-cluster.adoc#rosa-creating-cluster[Creating a ROSA cluster without AWS STS] and xref:../rosa_install_access_delete_clusters/rosa-aws-privatelink-creating-cluster.adoc#rosa-aws-privatelink-creating-cluster[Creating an AWS PrivateLink cluster on ROSA].
|
|
* For information about the account-wide IAM roles and policies that are required for ROSA deployments that use STS, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies_rosa-sts-about-iam-resources[Account-wide IAM role and policy reference].
|
|
* For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes].
|
|
* For information about the update life cycle for ROSA, see xref:../rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc#rosa-life-cycle[{product-title} update life cycle].
|
|
|
|
include::modules/rosa-getting-started-create-cluster-admin-user.adoc[leveloffset=+1]
|
|
|
|
.Additional resource
|
|
|
|
* For steps to log in to the ROSA web console, see xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started-access-cluster-web-console_rosa-getting-started[Accessing a cluster through the web console]
|
|
|
|
include::modules/rosa-getting-started-configure-an-idp-and-grant-access.adoc[leveloffset=+1]
|
|
include::modules/rosa-getting-started-configure-an-idp.adoc[leveloffset=+2]
|
|
|
|
.Additional resource
|
|
|
|
* For detailed steps to configure each of the supported identity provider types, see xref:../rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.adoc#rosa-sts-config-identity-providers[Configuring identity providers for STS]
|
|
|
|
include::modules/rosa-getting-started-grant-user-access.adoc[leveloffset=+2]
|
|
include::modules/rosa-getting-started-grant-admin-privileges.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-cluster-admin-role_rosa-service-definition[Cluster administration role]
|
|
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-customer-admin-user_rosa-service-definition[Customer administrator user]
|
|
|
|
include::modules/rosa-getting-started-access-cluster-web-console.adoc[leveloffset=+1]
|
|
include::modules/deploy-app.adoc[leveloffset=+1]
|
|
include::modules/rosa-getting-started-revoking-admin-privileges-and-user-access.adoc[leveloffset=+1]
|
|
include::modules/rosa-getting-started-revoke-admin-privileges.adoc[leveloffset=+2]
|
|
include::modules/rosa-getting-started-revoke-user-access.adoc[leveloffset=+2]
|
|
include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1]
|
|
|
|
[id="next-steps_{context}"]
|
|
== Next steps
|
|
|
|
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
|
|
* xref:../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes]
|
|
* xref:../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#preparing-to-configure-the-monitoring-stack-uwm[Preparing to configure the user workload monitoring stack]
|
|
|
|
[role="_additional-resources"]
|
|
[id="additional-resources_{context}"]
|
|
== Additional resources
|
|
|
|
* For more information about setting up accounts and ROSA clusters using AWS STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-overview-of-the-deployment-workflow[Understanding the ROSA with STS deployment workflow]
|
|
|
|
* For more information about setting up accounts and ROSA clusters without using AWS STS, see xref:../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-getting-started-workflow.adoc#rosa-understanding-the-deployment-workflow[Understanding the ROSA deployment workflow]
|
|
|
|
* For more information about upgrading your cluster, see xref:../upgrading/rosa-upgrading-sts.adoc#rosa-upgrading-sts[Upgrading ROSA Classic clusters]
|