Getting started

OpenShift Dedicated 4

Getting started with OpenShift Dedicated

Red Hat OpenShift Documentation Team

Abstract

Getting started with your OpenShift Dedicated cluster

Chapter 1. Quick start

Use this quick start to create and provision a cluster, add users, deploy your first application, and learn how to scale and delete your cluster.

1.1. Creating a cluster

You can quickly create a standard OpenShift Dedicated cluster, which deploys in cloud provider accounts owned by Red Hat.

Procedure

  1. Log in to OpenShift Cluster Manager (OCM).
  2. Click Create ClusterRed Hat OpenShift DedicatedCreate Clusters.
  3. Select a cloud infrastructure provider.
  4. Select Standard for the billing model.
  5. Enter a Cluster name.
  6. Select a Region and choose either a Single zone or Multizone availability.
  7. Select your Compute node instance type and the Compute node count. The number and types of nodes available to you depend on your OpenShift Dedicated subscription.
  8. Optional: Expand Edit node labels to add labels to your nodes. Click Add label to add more node labels.
  9. Select the amount of Persistent storage and Load balancers you want set on the deployed cluster or accept the defaults.
  10. The Basic Network configuration is selected by default. This setting creates a new VPC for your cluster using the default values.
  11. Select your cluster update method. Manual is selected by default. If you want your clusters to be automatically upgraded when new versions are available, select the Automatic option. If you opt for automatic upgrades, you must specify the preferred day of the week and the time (UTC) for the upgrade to start.
  12. Optional: You can set a grace period for Node Draining during cluster upgrades. A 1 hour grace period is set by default.
  13. Click Create cluster. The cluster creation process begins and takes about 30-40 minutes to complete.

Verification

  • The Installing cluster heading, under the Overview tab, indicates that the cluster is installing and you can view the installation logs from this heading. The Status indicator under the Details heading indicates when your cluster is Ready for use.

1.2. Configuring an identity provider

After your OpenShift Dedicated cluster is created, you must configure identity providers to determine how users log in to access the cluster. This example configures a GitHub identity provider.

Warning

Configuring GitHub authentication allows users to log in to OpenShift Dedicated with their GitHub credentials. To prevent anyone with any GitHub user ID from logging in to your OpenShift Dedicated cluster, you must restrict access to only those in specific GitHub organizations or teams.

Prerequisites

Procedure

  1. Navigate to the Clusters page and select the cluster that you need to configure identity providers for.
  2. Click the Access control tab.
  3. Click Add identity provider.

    Note

    You can also click the Add Oauth configuration link in the warning message displayed after cluster creation to configure your identity providers.

  4. Select GitHub from the drop-down menu.
  5. Enter a unique name for the identity provider. This name cannot be changed later.

    • An OAuth callback URL is automatically generated in the provided field. You will use this to register the GitHub application.

      https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name>

      For example:

      https://oauth-openshift.apps.example-openshift-cluster.com/oauth2callback/github/
  6. Register an application on GitHub.
  7. Return to OpenShift Dedicated and select a mapping method from the drop-down menu. Claim is recommended in most cases.
  8. Enter the Client ID and Client secret provided by GitHub.
  9. Enter a hostname. A hostname must be entered when using a hosted instance of GitHub Enterprise.
  10. Optional: You can use a certificate authority (CA) file to validate server certificates for the configured GitHub Enterprise URL. Click Browse to locate and attach a CA file to the identity provider.
  11. Select Use organizations or Use teams to restrict access to a particular GitHub organization or a GitHub team.
  12. Enter the name of the organization or team you would like to restrict access to. Click Add more to specify multiple organizations or teams that users can be a member of.
  13. Click Confirm.

Verification

  • The configured identity provider is now visible on the Access control tab of the Clusters page.

1.3. Adding a user

Administrator roles are managed using a dedicated-admins group on the cluster. You can add and remove users from OpenShift Cluster Manager (OCM).

Procedure

  1. Navigate to the Clusters page and select the cluster you want to add users to.
  2. Click the Access control tab.
  3. Under the Cluster administrative users heading, click Add User.
  4. Enter the user ID you want to add.
  5. Click Add user.

Verification

  • You now see the user listed under the Cluster administrative users heading.

1.4. Accessing your cluster

After you have configured your identity providers, users can access the cluster from the OpenShift Cluster Manager (OCM).

Prerequisites

  • You have created a cluster.
  • Identity providers have been configured for your cluster.

Procedure

  1. From OpenShift Cluster Manager (OCM), click on the cluster you want to access.
  2. Click Open Console.
  3. Click on your identity provider and provide your credentials to log into the cluster.

Verification

  • After you have accessed the cluster, you are directed to the console for your OpenShift Dedicated cluster.

1.5. Deploying an app with the OpenShift service catalog

From the OpenShift web console, you can deploy one of the built-in service catalog apps and expose the app with a route.

Prerequisites

  • An actively running cluster.

Procedure

  1. From OpenShift Cluster Manager (OCM), click Open console.
  2. From the side navigation menu in the Administrator perspective, click HomeProjects and then click Create Project.
  3. Enter a name for your project. Optional: Add a Display Name and Description. Click Create.
  4. Switch to the Developer perspective from the side navigation menu to create an app.
  5. Click +Add from the side navigation menu. From the Add pane menu bar, make sure that the Project is the one that you just created.
  6. Click From Catalog. The Developer Catalog opens in the pane.
  7. From the navigation menu in the pane, click LanguagesJavaScript.
  8. Click Node.js, and then click Create Application. After you select Node.js, the Create Source-to-Image Application pane opens.

    Note

    You might need to click Clear All Filters to display the Node.js option.

  9. In the Git section, click Try Sample.
  10. Scroll to confirm that Deployment and Create a route to the application are selected.
  11. Click Create. It will take a few minutes for the pods to deploy.
  12. Optional: You can check the status of the pods from the Topology pane. Click your nodejs app and review its sidebar. You must see that the nodejs build is complete, and that the nodejs pod is in a Running state to continue.
  13. When the deployment is complete, click the route location URL, which has a format similar to the following:

    http://nodejs-<project>.<cluster_name>-<hash>.<region>.containers.appdomain.cloud

    A new tab in your browser opens with a message similar to the following.

    Welcome to your Node.js application on OpenShift
  14. Optional: To clean up the resources that you created, select Administrator from the perspective switcher, navigate to HomeProjects, click your project’s action menu, and click Delete Project.

1.6. Scaling your cluster

You can scale your OpenShift Dedicated cluster from the OpenShift Cluster Manager (OCM).

Procedure

  1. From OCM, click on the cluster you want to resize.
  2. Click ActionsEdit load balancers and persistent storage

    1. Use the drop-down menu to select how many Load balancers you want to scale to.
    2. Use the drop-down menu to select the amount of Persistent storage you want to scale to.
    3. Click Apply. Scaling occurs automatically.
  3. Click ActionsEdit node count.

    1. Use the drop down menu to select the Machine Pool setting you want to scale to.
    2. Use the drop down menu to select the Node Count you want to scale to.
    3. Click Apply. Scaling occurs automatically.

Verification

  • In the Overview tab under the Details heading, the Status indicator shows that your cluster is Ready for use.

1.7. Deleting your cluster

You can delete your OpenShift Dedicated cluster in the OpenShift Cluster Manager (OCM).

Procedure

  1. From OpenShift Cluster Manager (OCM), click on the cluster you want to delete.
  2. Click ActionsDelete Cluster.
  3. Type the name of the cluster highlighted in bold, then click Delete.

Cluster deletion occurs automatically.

Legal Notice

Copyright © 2021 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.