Getting started

Procedure

1. Navigate to OpenShift Cluster Manager and select your cluster.
2. Select Access control → Identity providers.
3. Select the GitHub identity provider type from the Add identity provider drop-down menu.
4. Enter a unique name for the identity provider. The name cannot be changed later.

5. Register an OAuth application in your GitHub organization by following the steps in the GitHub documentation.

   Note

   You must register the OAuth app under your GitHub organization. If you register an OAuth application that is not owned by the organization that contains your cluster users or teams, then user authentication to the cluster will not succeed.

   • For the homepage URL in your GitHub OAuth app configuration, specify the https://oauth-openshift.apps.<cluster_name>.<cluster_domain> portion of the OAuth callback URL that is automatically generated in the Add a GitHub identity provider page on OpenShift Cluster Manager.

     The following is an example of a homepage URL for a GitHub identity provider:

     https://oauth-openshift.apps.openshift-cluster.example.com

   • For the authorization callback URL in your GitHub OAuth app configuration, specify the full OAuth callback URL that is automatically generated in the Add a GitHub identity provider page on OpenShift Cluster Manager. The full URL has the following syntax:

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

6. Return to the Edit identity provider: GitHub dialog in OpenShift Cluster Manager and select Claim from the Mapping method drop-down menu.
7. Enter the Client ID and Client secret for your GitHub OAuth application. The GitHub page for your OAuth app provides the ID and secret.

8. Optional: Enter a hostname.

   Note

   A hostname must be entered when using a hosted instance of GitHub Enterprise.

9. Optional: You can specify a certificate authority (CA) file to validate server certificates for a configured GitHub Enterprise URL. Click Browse to locate and attach a CA file to the identity provider.
10. Select Use organizations or Use teams to restrict access to a GitHub organization or a GitHub team within an organization.

11. Enter the name of the organization or team you would like to restrict access to. Click Add more to specify multiple organizations or teams.

    Note

    Specified organizations must own an OAuth app that was registered by using the preceding steps. If you specify a team, it must exist within an organization that owns an OAuth app that was registered by using the preceding steps.

12. Click Add to apply the identity provider configuration.

    Note

    It might take approximately two minutes for the identity provider configuration to become active.

Procedure

1. Navigate to OpenShift Cluster Manager and select your cluster.
2. Click the Access control tab.
3. In the Cluster Roles and Access tab, click Add user.
4. Enter the user ID of an identity provider user.
5. Click Add user to grant dedicated-admin cluster privileges to the user.

Procedure

1. From OpenShift Cluster Manager, 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.
4. Click Open console to open the web console for your cluster.
5. Click on your identity provider and provide your credentials to log in to the cluster. Complete any authorization requests that are presented by your provider.

Procedure

1. Go to the Cluster List page in OpenShift Cluster Manager.
2. Click the options icon (⋮) next to the cluster you want to view.
3. Click Open console.
4. Your cluster console opens in a new browser window. Log in to your Red Hat account with your configured identity provider credentials.
5. In the Administrator perspective, select Home → Projects → Create Project.
6. Enter a name for your project and optionally add a Display Name and Description.
7. Click Create to create the project.
8. Switch to the Developer perspective and select +Add. Verify that the selected Project is the one that you just created.
9. In the Developer Catalog dialog, select All services.
10. In the Developer Catalog page, select Languages → JavaScript from the menu.

11. Click Node.js, and then click Create to open the Create Source-to-Image application page.

    Note

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

12. In the Git section, click Try sample.
13. Add a unique name in the Name field. The value will be used to name the associated resources.
14. Confirm that Deployment and Create a route are selected.
15. Click Create to deploy the application. It will take a few minutes for the pods to deploy.
16. Optional: Check the status of the pods in the Topology pane by selecting your Node.js app and reviewing its sidebar. You must wait for the nodejs build to complete and for the nodejs pod to be in a Running state before continuing.

17. When the deployment is complete, click the route URL for the application, which has a format similar to the following:

    https://nodejs-<project>.<cluster_name>.<hash>.<region>.openshiftapps.com/

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

    Welcome to your Node.js application on OpenShift

18. Optional: Delete the application and clean up the resources that you created:

    1. In the Administrator perspective, navigate to Home → Projects.
    2. Click the action menu for your project and select Delete Project.

Procedure

1. Navigate to OpenShift Cluster Manager and select your cluster.
2. Click the Access control tab.
3. In the Cluster Roles and Access tab, select next to a user and click Delete.

Procedure

1. Navigate to github.com and log in to your GitHub account.

2. Remove the user from your GitHub organization or team:

   • If your identity provider configuration uses a GitHub organization, follow the steps in Removing a member from your organization in the GitHub documentation.
   • If your identity provider configuration uses a team within a GitHub organization, follow the steps in Removing organization members from a team in the GitHub documentation.

Procedure

1. From OpenShift Cluster Manager, click on the cluster you want to delete.
2. Select Delete cluster from the Actions drop-down menu.

3. Type the name of the cluster highlighted in bold, then click Delete. Cluster deletion occurs automatically.

   Note

   If you delete a cluster that was installed into a GCP Shared VPC, inform the VPC owner of the host project to remove the IAM policy roles granted to the service account that was referenced during cluster creation.