1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/rosa_getting_started/rosa-quickstart-guide-ui.adoc

171 lines
9.7 KiB
Plaintext
Raw Normal View History

:_mod-docs-content-type: ASSEMBLY
[id="rosa-quickstart-guide-ui"]
= {product-title} quick start guide
2022-10-18 15:48:25 -04:00
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-quickstart-guide-ui
2022-10-18 15:48:25 -04:00
toc::[]
[NOTE]
====
2024-06-03 15:42:17 -07:00
If you are looking for a comprehensive getting started guide for {product-title} (ROSA), see xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Comprehensive guide to getting started with {product-title}]. For additional information on ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red{nbsp}Hat OpenShift Service on AWS (ROSA) interactive walkthrough].
2022-10-18 15:48:25 -04:00
====
Follow this guide to quickly create a {product-title} (ROSA) cluster using {cluster-manager-first} on the {hybrid-console-url}, grant user access, deploy your first application, and learn how to revoke user access and delete your cluster.
2022-10-18 15:48:25 -04:00
The procedures in this document enable you to create a cluster that uses AWS Security Token Service (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].
2022-11-17 16:03:53 -05:00
image::291_OpenShift_on_AWS_Intro_1122_docs.png[{product-title}]
2022-10-18 15:48:25 -04:00
[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].
2022-10-18 15:48:25 -04:00
* 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
2022-10-18 15:48:25 -04:00
* You have reviewed the detailed xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
2022-10-18 15:48:25 -04:00
* 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].
//This content is pulled from rosa-getting-started-environment-setup.adoc
include::modules/rosa-getting-started-environment-setup.adoc[leveloffset=+1]
//This content is pulled from rosa-getting-started-enable-rosa.adoc
[discrete]
include::modules/rosa-getting-started-enable-rosa.adoc[leveloffset=+2]
//This content is pulled from rosa-getting-started-install-configure-cli-tools
[discrete]
include::modules/rosa-getting-started-install-configure-cli-tools.adoc[leveloffset=+2]
//This content is pulled from rosa-sts-creating-a-cluster-quickly.adoc
[id="rosa-quickstart-creating-a-cluster"]
== Creating a ROSA cluster with AWS STS using the default auto mode
2024-06-03 15:42:17 -07:00
{cluster-manager-first} is a managed service on the {hybrid-console-url} where you can install, modify, operate, and upgrade your Red{nbsp}Hat OpenShift clusters. This service allows you to work with all of your organizations clusters from a single dashboard.
The procedures in this document use the `auto` modes in {cluster-manager} to immediately create the required Identity and Access Management (IAM) resources using the current AWS account. The required resources include the account-wide IAM roles and policies, cluster-specific Operator roles and policies, and OpenID Connect (OIDC) identity provider.
2022-10-18 15:48:25 -04:00
//This content is pulled from rosa-sts-creating-a-cluster-quickly-ocm.adoc
When using the {cluster-manager} {hybrid-console-second} to create a {product-title} (ROSA) cluster that uses the STS, you can select the default options to create the cluster quickly.
2024-06-03 15:42:17 -07:00
Before you can use the {cluster-manager} {hybrid-console-second} to deploy ROSA with STS clusters, you must associate your AWS account with your Red{nbsp}Hat organization and create the required account-wide STS roles and policies.
2022-10-18 15:48:25 -04:00
//This content is pulled from rosa-sts-overview-of-the-default-cluster-specifications.adoc
[discrete]
include::modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc[leveloffset=+2]
//This content is pulled from rosa-sts-understanding-aws-account-association.adoc
[discrete]
include::modules/rosa-sts-understanding-aws-account-association.adoc[leveloffset=+2]
//This content is pulled from rosa-sts-associating-your-aws-account.adoc
[discrete]
include::modules/rosa-sts-associating-your-aws-account.adoc[leveloffset=+2]
//This content is pulled from rosa-sts-creating-account-wide-sts-roles-and-policies.adoc
[discrete]
include::modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+2]
//This content is pulled from rosa-sts-creating-a-cluster-using-defaults-ocm.adoc
[discrete]
include::modules/rosa-sts-creating-a-cluster-using-defaults-ocm.adoc[leveloffset=+2]
////
.Additional resources
* 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].
////
//This content is pulled from rosa-getting-started-create-cluster-admin-user.adoc
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-quickstart-guide-ui.adoc#rosa-getting-started-access-cluster-web-console_rosa-quickstart-guide-ui[Accessing a cluster through the web console].
2022-10-18 15:48:25 -04:00
//This content is pulled from rosa-getting-started-configure-an-idp-and-grant-access.adoc
include::modules/rosa-getting-started-configure-an-idp-and-grant-access.adoc[leveloffset=+1]
//This content is pulled from rosa-getting-started-configure-an-idp.adoc
[discrete]
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].
//This content is pulled from rosa-getting-started-grant-user-access.adoc
[discrete]
include::modules/rosa-getting-started-grant-user-access.adoc[leveloffset=+2]
//This content is pulled from rosa-getting-started-grant-admin-privileges.adoc
[discrete]
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]
2023-11-02 16:10:48 -04:00
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-customer-admin-user_rosa-service-definition[Customer administrator user]
2022-10-18 15:48:25 -04:00
//This content is pulled from rosa-getting-started-access-cluster-web-console.adoc
include::modules/rosa-getting-started-access-cluster-web-console.adoc[leveloffset=+1]
//This content is pulled from deploy-app.adoc
include::modules/deploy-app.adoc[leveloffset=+1]
//This content is pulled from rosa-getting-started-revoking-admin-privileges-and-user-access.adoc
include::modules/rosa-getting-started-revoking-admin-privileges-and-user-access.adoc[leveloffset=+1]
//This content is pulled from rosa-getting-started-revoke-admin-privileges.adoc
[discrete]
include::modules/rosa-getting-started-revoke-admin-privileges.adoc[leveloffset=+2]
//This content is pulled from rosa-getting-started-revoke-admin-privileges.adoc
[discrete]
include::modules/rosa-getting-started-revoke-user-access.adoc[leveloffset=+2]
//This content is pulled from rosa-getting-started-deleting-a-cluster.adoc
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]
2022-10-18 15:48:25 -04:00
[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].
2022-10-18 15:48:25 -04:00
2024-04-24 16:45:49 -04:00
* 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].
2022-10-18 15:48:25 -04:00
2024-04-24 16:45:49 -04:00
* For more information about upgrading your cluster, see xref:../upgrading/rosa-upgrading-sts.adoc#rosa-upgrading-sts[Upgrading ROSA Classic clusters].