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.
- Log in to OpenShift Cluster Manager (OCM).
- Click Create Cluster → Red Hat OpenShift Dedicated → Create Clusters.
- Select a cloud infrastructure provider.
- Select Standard for the billing model.
- Enter a Cluster name.
- Select a Region and choose either a Single zone or Multizone availability.
- 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.
- Optional: Expand Edit node labels to add labels to your nodes. Click Add label to add more node labels.
- Select the amount of Persistent storage and Load balancers you want set on the deployed cluster or accept the defaults.
- The Basic Network configuration is selected by default. This setting creates a new VPC for your cluster using the default values.
- 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.
- Optional: You can set a grace period for Node Draining during cluster upgrades. A 1 hour grace period is set by default.
- Click Create cluster. The cluster creation process begins and takes about 30-40 minutes to complete.
- 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.
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.
- Navigate to the Clusters page and select the cluster that you need to configure identity providers for.
- Click the Access control tab.
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.
- Select GitHub from the drop-down menu.
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.
- Register an application on GitHub.
- Return to OpenShift Dedicated and select a mapping method from the drop-down menu. Claim is recommended in most cases.
- Enter the Client ID and Client secret provided by GitHub.
- Enter a hostname. A hostname must be entered when using a hosted instance of GitHub Enterprise.
- 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.
- Select Use organizations or Use teams to restrict access to a particular GitHub organization or a GitHub team.
- 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.
- Click Confirm.
- 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).
- Navigate to the Clusters page and select the cluster you want to add users to.
- Click the Access control tab.
- Under the Cluster administrative users heading, click Add User.
- Enter the user ID you want to add.
- Click Add user.
- 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).
- You have created a cluster.
- Identity providers have been configured for your cluster.
- From OpenShift Cluster Manager (OCM), click on the cluster you want to access.
- Click Open Console.
- Click on your identity provider and provide your credentials to log into the cluster.
- 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.
- An actively running cluster.
- From OpenShift Cluster Manager (OCM), click Open console.
- From the side navigation menu in the Administrator perspective, click Home → Projects and then click Create Project.
- Enter a name for your project. Optional: Add a Display Name and Description. Click Create.
- Switch to the Developer perspective from the side navigation menu to create an app.
- 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.
- Click From Catalog. The Developer Catalog opens in the pane.
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.
- In the Git section, click Try Sample.
- Scroll to confirm that Deployment and Create a route to the application are selected.
- Click Create. It will take a few minutes for the pods to deploy.
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
nodejsbuild is complete, and that the
nodejspod is in a Running state to continue.
When the deployment is complete, click the route location URL, which has a format similar to the following:
A new tab in your browser opens with a message similar to the following.
Welcome to your Node.js application on OpenShift
- Optional: To clean up the resources that you created, select Administrator from the perspective switcher, navigate to Home → Projects, 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).
- From OCM, click on the cluster you want to resize.
Click Actions → Edit load balancers and persistent storage
- Use the drop-down menu to select how many Load balancers you want to scale to.
- Use the drop-down menu to select the amount of Persistent storage you want to scale to.
- Click Apply. Scaling occurs automatically.
Click Actions → Edit node count.
- Use the drop down menu to select the Machine Pool setting you want to scale to.
- Use the drop down menu to select the Node Count you want to scale to.
- Click Apply. Scaling occurs automatically.
- 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).
- From OpenShift Cluster Manager (OCM), click on the cluster you want to delete.
- Click Actions → Delete Cluster.
- Type the name of the cluster highlighted in bold, then click Delete.
Cluster deletion occurs automatically.