--- title: Deploy a Local Openshift Cluster description: Some customers are using Openshift as their platform for running Ping containerized applications. If this is the case, access to an Openshift cluster is assumed. Even in those cases, there are times where a local implementation of Openshift for development and testing is convenient. component: devops page_id: devops::deployment/deployLocalOpenshift canonical_url: https://developer.pingidentity.com/devops/deployment/deployLocalOpenshift.html section_ids: devops-prerequisites: Prerequisites devops-configuration-and-setup: Configuration and Setup devops-stop-the-red-hat-openshift-local-instance: Stop the Red Hat Openshift Local instance devops-delete-the-red-hat-openshift-local-instance: Delete the Red Hat Openshift Local instance --- # Deploy a Local Openshift Cluster | | | | - | ------------------------------------------------------------------------------------------------------- | | | The instructions in this document are for testing and learning, and not intended for use in production. | | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | Openshift is a licensed product following the open source model where "upstream" versions are available under community licensing, but the official release supported by [Red Hat](https://www.redhat.com/en) requires a subscription in order to access the software for installation. This guide assumes the user has access to such a license. Red Hat provides a [free Developer account](https://developers.redhat.com/blog/2016/03/31/no-cost-rhel-developer-subscription-now-available) that allows a participant to obtain a 60-day license of the Openshift product at no charge. | | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | A video demonstration of the process outlined on this page is available [here](https://videos.pingidentity.com/detail/videos/devops/video/6319613511112/openshift-local-demonstration). | Some customers are using Openshift as their platform for running Ping containerized applications. If this is the case, access to an Openshift cluster is assumed. Even in those cases, there are times where a local implementation of Openshift for development and testing is convenient. | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | For this guide, the Apple MacBook Pro M4 platform is used, and the release of the *Red Hat Openshift Local* offering is version 2.49.0, which installs Openshift 4.18.2. | The [Openshift Local](https://developers.redhat.com/products/openshift-local/overview) offering is used in this guide. ## Prerequisites * Entitlement for Openshift code. If you have registered for the Red Hat developer program, you can obtain your entitlement for the free trial [from the portal](https://developers.redhat.com/products/openshift/download) after logging in. * [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) * [Openshift client (oc)](https://access.redhat.com/documentation/en-us/openshift_container_platform/4.17/html-single/cli_tools/index#cli-getting-started) * ports 80, 443 and 6443 available on machine. If you have Docker Desktop installed, you must either disable Kubernetes or stop Docker in order for the installation to work. * **sudo** privileges on your hosting environment ## Configuration and Setup 1. [Install the Red Hat Openshift Local binary](https://console.redhat.com/openshift/create/local) for your platform. When you download the installer, also download the pull secret. 2. With the `crc` utility installed, configure settings. Provide as much RAM and CPU as you can, depending on your system. In this example, 20 GB of RAM, 9 vCPUs, and a disk size of 80GB are set. The consent-telemetry is optional, depending on whether you consent to usage data metrics being sent to Red Hat. ``` # Version information crc version # Output CRC version: 2.49.0+e843be OpenShift version: 4.18.2 MicroShift version: 4.18.2 # Set configuration crc config set memory 20480 crc config set cpus 9 crc config set consent-telemetry no crc config set disk-size 80 crc config set pull-secret-file /pull-secret.txt # Confirm crc config view - consent-telemetry : no - cpus : 9 - disk-size : 80 - memory : 20480 - pull-secret-file : /pull-secret.txt ``` 3. Set up your local machine for running Red Hat Openshift Local by running **crc setup**: ``` crc setup # Output INFO Using bundle path /Users/davidross/.crc/cache/crc_vfkit_4.18.2_arm64.crcbundle INFO Checking if running macOS version >= 13.x INFO Checking if running as non-root INFO Checking if crc-admin-helper executable is cached INFO Checking if running on a supported CPU architecture INFO Checking if crc executable symlink exists INFO Checking minimum RAM requirements INFO Check if Podman binary exists in: /Users/davidross/.crc/bin/oc INFO Checking if running emulated on Apple silicon INFO Checking if vfkit is installed INFO Checking if CRC bundle is extracted in '$HOME/.crc' INFO Checking if /Users/davidross/.crc/cache/crc_vfkit_4.18.2_arm64.crcbundle exists INFO Getting bundle for the CRC executable INFO Downloading bundle: /Users/davidross/.crc/cache/crc_vfkit_4.18.2_arm64.crcbundle... 5.35 GiB / 5.35 GiB [---------------------------------------] 100.00% 38.49 MiB/s INFO Uncompressing /Users/davidross/.crc/cache/crc_vfkit_4.18.2_arm64.crcbundle crc.img: 31.00 GiB / 31.00 GiB [--------------------------------------] 100.00% oc: 138.71 MiB / 138.71 MiB [-----------------------------------------] 100.00% INFO Checking if old launchd config for tray and/or daemon exists INFO Checking if crc daemon plist file is present and loaded INFO Adding crc daemon plist file and loading it INFO Checking SSH port availability Your system is correctly setup for using CRC. Use 'crc start' to start the instance ``` 4. Start the Red Hat Openshift Local instance: ``` crc start # Output INFO Using bundle path /Users/davidross/.crc/cache/crc_vfkit_4.18.2_arm64.crcbundle INFO Checking if running macOS version >= 13.x INFO Checking if running as non-root INFO Checking if crc-admin-helper executable is cached INFO Checking if running on a supported CPU architecture INFO Checking if crc executable symlink exists INFO Checking minimum RAM requirements INFO Check if Podman binary exists in: /Users/davidross/.crc/bin/oc INFO Checking if running emulated on Apple silicon INFO Checking if vfkit is installed INFO Checking if old launchd config for tray and/or daemon exists INFO Checking if crc daemon plist file is present and loaded INFO Checking SSH port availability INFO Loading bundle: crc_vfkit_4.18.2_arm64... INFO Starting CRC VM for openshift 4.18.2... INFO CRC instance is running with IP 127.0.0.1 INFO CRC VM is running INFO Updating authorized keys... INFO Resizing /dev/vda4 filesystem INFO Configuring shared directories INFO Check internal and public DNS query... INFO Check DNS query from host... INFO Verifying validity of the kubelet certificates... INFO Starting kubelet service INFO Waiting for kube-apiserver availability... [takes around 2min] INFO Adding user's pull secret to the cluster... INFO Updating SSH key to machine config resource... INFO Waiting until the user's pull secret is written to the instance disk... INFO Changing the password for the kubeadmin user INFO Updating cluster ID... INFO Updating root CA cert to admin-kubeconfig-client-ca configmap... INFO Starting openshift instance... [waiting for the cluster to stabilize] INFO Operator authentication is progressing INFO Operator console is progressing INFO All operators are available. Ensuring stability... INFO Operators are stable (2/3)... INFO Operators are stable (3/3)... INFO Adding crc-admin and crc-developer contexts to kubeconfig... Started the OpenShift cluster. The server is accessible via web console at: https://console-openshift-console.apps-crc.testing Log in as administrator: Username: kubeadmin Password: Log in as user: Username: developer Password: Use the 'oc' command line interface: $ eval $(crc oc-env) $ oc login -u developer https://api.crc.testing:6443 ``` Depending on the speed of your system, this will take 5 to 15 minutes. There is a 10 minute timeout on checking the stability of operators deployed by Openshift. It might be the case that the tool reports these have not reached full stability in that window, particularly if using an Apple MacBook Pro with an Intel chip. In the writing of this guide, no issues were found using Openshift deployed in this manner, even if the error occurs. Each time the steps in this guide were tested, everything eventually reached a healthy status, even if not in the window expected on some occasions. Setup is complete. This local environment should be ready to deploy our [Helm examples](https://developer.pingidentity.com/helm/examples/index.html). ## Stop the Red Hat Openshift Local instance When not working with the environment, you can stop the instance by running the following command. All settings, projects and objects created will be retained and available when it is started again. `crc stop` Run `crc start` again to launch the instance. ## Delete the Red Hat Openshift Local instance You can also remove the instance by running the following command. If you take this action, the embedded VM instance, all objects and projects created will be lost. A new instance will be deployed the next time you run `crc start`. `crc delete` | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Deleting the instance does not delete the configuration settings for Red Hat Openshift Local (RAM, CPU, disk, and so on, created or modified when running the `crc config set` command). If you want to completely remove all configuration, you can delete the $HOME/.crc folder and its contents. Also, you will need to edit `/etc/hosts` and remove the following aliases to the 127.0.0.1 IP: `api.crc.testing canary-openshift-ingress-canary.apps-crc.testing console-openshift-console.apps-crc.testing default-route-openshift-image-registry.apps-crc.testing downloads-openshift-console.apps-crc.testing host.crc.testing oauth-openshift.apps-crc.testing` |