Red Hat SummitThis documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Este contenido no está disponible en el idioma seleccionado.
CLI tools
Learning how to use the command-line tools for OpenShift Container Platform
Abstract
Chapter 1. OpenShift CLI (oc)
1.1. Getting started with the CLI
1.1.1. About the CLI
With the OpenShift Container Platform command-line interface (CLI), you can create applications and manage OpenShift Container Platform projects from a terminal. The CLI is ideal in situations where you:
- Work directly with project source code.
- Script OpenShift Container Platform operations.
- Are restricted by bandwidth resources and can not use the web console.
1.1.2. Installing the CLI
You can install the OpenShift CLI (oc) in order to interact with OpenShift Container Platform from a command-line interface. You can install oc on Linux, Windows, or macOS.
If you installed an earlier version of oc, you cannot use it to complete all of the commands in OpenShift Container Platform 4.2. Download and install the new version of oc.
1.1.2.1. Installing the CLI on Linux
You can install the OpenShift CLI (oc) binary on Linux by using the following procedure.
Procedure
- Navigate to the Infrastructure Provider page on the Red Hat OpenShift Cluster Manager site.
- Select your infrastructure provider, and, if applicable, your installation type.
- In the Command-line interface section, select Linux from the drop-down menu and click Download command-line tools.
Unpack the archive:
tar xvzf <file>
$ tar xvzf <file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Place the
ocbinary in a directory that is on yourPATH.To check your
PATH, execute the following command:echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
After you install the CLI, it is available using the oc command:
oc <command>
$ oc <command>1.1.2.2. Installing the CLI on Windows
You can install the OpenShift CLI (oc) binary on Windows by using the following procedure.
Procedure
- Navigate to the Infrastructure Provider page on the Red Hat OpenShift Cluster Manager site.
- Select your infrastructure provider, and, if applicable, your installation type.
- In the Command-line interface section, select Windows from the drop-down menu and click Download command-line tools.
- Unzip the archive with a ZIP program.
Move the
ocbinary to a directory that is on yourPATH.To check your
PATH, open the command prompt and execute the following command:path
C:\> pathCopy to Clipboard Copied! Toggle word wrap Toggle overflow
After you install the CLI, it is available using the oc command:
oc <command>
C:\> oc <command>1.1.2.3. Installing the CLI on macOS
You can install the OpenShift CLI (oc) binary on macOS by using the following procedure.
Procedure
- Navigate to the Infrastructure Provider page on the Red Hat OpenShift Cluster Manager site.
- Select your infrastructure provider, and, if applicable, your installation type.
- In the Command-line interface section, select MacOS from the drop-down menu and click Download command-line tools.
- Unpack and unzip the archive.
Move the
ocbinary to a directory on your PATH.To check your
PATH, open a terminal and execute the following command:echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
After you install the CLI, it is available using the oc command:
oc <command>
$ oc <command>1.1.3. Logging in to the CLI
You can log in to the oc CLI to access and manage your cluster.
Prerequisites
- You must have access to an OpenShift Container Platform cluster.
- You must have installed the CLI.
Procedure
Log in to the CLI using the
oc logincommand and enter the required information when prompted.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
You can now create a project or issue other commands for managing your cluster.
1.1.4. Using the CLI
Review the following sections to learn how to complete common tasks using the CLI.
1.1.4.1. Creating a project
Use the oc new-project command to create a new project.
oc new-project my-project
$ oc new-project my-project
Now using project "my-project" on server "https://openshift.example.com:6443".1.1.4.2. Creating a new app
Use the oc new-app command to create a new application.
1.1.4.3. Viewing pods
Use the oc get pods command to view the pods for the current project.
oc get pods -o wide
$ oc get pods -o wide
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE
cakephp-ex-1-build 0/1 Completed 0 5m45s 10.131.0.10 ip-10-0-141-74.ec2.internal <none>
cakephp-ex-1-deploy 0/1 Completed 0 3m44s 10.129.2.9 ip-10-0-147-65.ec2.internal <none>
cakephp-ex-1-ktz97 1/1 Running 0 3m33s 10.128.2.11 ip-10-0-168-105.ec2.internal <none>1.1.4.4. Viewing pod logs
Use the oc logs command to view logs for a particular pod.
oc logs cakephp-ex-1-deploy
$ oc logs cakephp-ex-1-deploy
--> Scaling cakephp-ex-1 to 1
--> Success1.1.4.5. Viewing the current project
Use the oc project command to view the current project.
oc project
$ oc project
Using project "my-project" on server "https://openshift.example.com:6443".1.1.4.6. Viewing the status for the current project
Use the oc status command to view information about the current project, such as Services, DeploymentConfigs, and BuildConfigs.
1.1.4.7. Listing supported API resources
Use the oc api-resources command to view the list of supported API resources on the server.
1.1.5. Getting help
You can get help with CLI commands and OpenShift Container Platform resources in the following ways.
Use
oc helpto get a list and description of all available CLI commands:Example: Get general help for the CLI
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Use the
--helpflag to get help about a specific CLI command:Example: Get help for the
oc createcommandCopy to Clipboard Copied! Toggle word wrap Toggle overflow Use the
oc explaincommand to view the description and fields for a particular resource:Example: View documentation for the Pod resource
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.1.6. Logging out of the CLI
You can log out the CLI to end your current session.
Use the
oc logoutcommand.oc logout
$ oc logout Logged "user1" out on "https://openshift.example.com"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
This deletes the saved authentication token from the server and removes it from your configuration file.
1.2. Configuring the CLI
1.2.1. Enabling tab completion
After you install the oc CLI tool, you can enable tab completion to automatically complete oc commands or suggest options when you press Tab.
Prerequisites
-
You must have the
ocCLI tool installed.
Procedure
The following procedure enables tab completion for Bash.
Save the Bash completion code to a file.
oc completion bash > oc_bash_completion
$ oc completion bash > oc_bash_completionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy the file to
/etc/bash_completion.d/.sudo cp oc_bash_completion /etc/bash_completion.d/
$ sudo cp oc_bash_completion /etc/bash_completion.d/Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can also save the file to a local directory and source it from your
.bashrcfile instead.
Tab completion is enabled when you open a new terminal.
1.3. Extending the CLI with plug-ins
You can write and install plug-ins to build on the default oc commands, allowing you to perform new and more complex tasks with the OpenShift Container Platform CLI.
1.3.1. Writing CLI plug-ins
You can write a plug-in for the OpenShift Container Platform CLI in any programming language or script that allows you to write command-line commands. Note that you can not use a plug-in to overwrite an existing oc command.
OpenShift CLI plug-ins are currently a Technology Preview feature. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
See the Red Hat Technology Preview features support scope for more information.
Procedure
This procedure creates a simple Bash plug-in that prints a message to the terminal when the oc foo command is issued.
Create a file called
oc-foo.When naming your plug-in file, keep the following in mind:
-
The file must begin with
oc-orkubectl-in order to be recognized as a plug-in. -
The file name determines the command that invokes the plug-in. For example, a plug-in with the file name
oc-foo-barcan be invoked by a command ofoc foo bar. You can also use underscores if you want the command to contain dashes. For example, a plug-in with the file nameoc-foo_barcan be invoked by a command ofoc foo-bar.
-
The file must begin with
Add the following contents to the file.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
After you install this plug-in for the OpenShift Container Platform CLI, it can be invoked using the oc foo command.
Additional resources
- Review the Sample plug-in repository for an example of a plug-in written in Go.
- Review the CLI runtime repository for a set of utilities to assist in writing plug-ins in Go.
1.3.2. Installing and using CLI plug-ins
After you write a custom plug-in for the OpenShift Container Platform CLI, you must install it to use the functionality that it provides.
OpenShift CLI plug-ins are currently a Technology Preview feature. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
See the Red Hat Technology Preview features support scope for more information.
Prerequisites
-
You must have the
ocCLI tool installed. -
You must have a CLI plug-in file that begins with
oc-orkubectl-.
Procedure
If necessary, update the plug-in file to be executable.
chmod +x <plugin_file>
$ chmod +x <plugin_file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Place the file anywhere in your
PATH, such as/usr/local/bin/.sudo mv <plugin_file> /usr/local/bin/.
$ sudo mv <plugin_file> /usr/local/bin/.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run
oc plugin listto make sure that the plug-in is listed.oc plugin list
$ oc plugin list The following compatible plugins are available: /usr/local/bin/<plugin_file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow If your plug-in is not listed here, verify that the file begins with
oc-orkubectl-, is executable, and is on yourPATH.Invoke the new command or option introduced by the plug-in.
For example, if you built and installed the
kubectl-nsplug-in from the Sample plug-in repository, you can use the following command to view the current namespace.oc ns
$ oc nsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Note that the command to invoke the plug-in depends on the plug-in file name. For example, a plug-in with the file name of
oc-foo-baris invoked by theoc foo barcommand.
1.4. Developer CLI commands
1.4.1. Basic CLI commands
1.4.1.1. explain
Display documentation for a certain resource.
Example: Display documentation for Pods
oc explain pods
$ oc explain pods1.4.1.2. login
Log in to the OpenShift Container Platform server and save login information for subsequent use.
Example: Interactive login
oc login
$ oc loginExample: Log in specifying a user name
oc login -u user1
$ oc login -u user11.4.1.3. new-app
Create a new application by specifying source code, a template, or an image.
Example: Create a new application from a local Git repository
oc new-app .
$ oc new-app .Example: Create a new application from a remote Git repository
oc new-app https://github.com/sclorg/cakephp-ex
$ oc new-app https://github.com/sclorg/cakephp-exExample: Create a new application from a private remote repository
oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret
$ oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret1.4.1.4. new-project
Create a new project and switch to it as the default project in your configuration.
Example: Create a new project
oc new-project myproject
$ oc new-project myproject1.4.1.5. project
Switch to another project and make it the default in your configuration.
Example: Switch to a different project
oc project test-project
$ oc project test-project1.4.1.6. projects
Display information about the current active project and existing projects on the server.
Example: List all projects
oc projects
$ oc projects1.4.1.7. status
Show a high-level overview of the current project.
Example: Show the status of the current project
oc status
$ oc status1.4.2. Build and Deploy CLI commands
1.4.2.1. cancel-build
Cancel a running, pending, or new build.
Example: Cancel a build
oc cancel-build python-1
$ oc cancel-build python-1Example: Cancel all pending builds from the python BuildConfig
oc cancel-build buildconfig/python --state=pending
$ oc cancel-build buildconfig/python --state=pending1.4.2.2. import-image
Import the latest tag and image information from an image repository.
Example: Import the latest image information
oc import-image my-ruby
$ oc import-image my-ruby1.4.2.3. new-build
Create a new BuildConfig from source code.
Example: Create a BuildConfig from a local Git repository
oc new-build .
$ oc new-build .Example: Create a BuildConfig from a remote Git repository
oc new-build https://github.com/sclorg/cakephp-ex
$ oc new-build https://github.com/sclorg/cakephp-ex1.4.2.4. rollback
Revert an application back to a previous Deployment.
Example: Roll back to the last successful Deployment
oc rollback php
$ oc rollback phpExample: Roll back to a specific version
oc rollback php --to-version=3
$ oc rollback php --to-version=31.4.2.5. rollout
Start a new rollout, view its status or history, or roll back to a previous revision of your application.
Example: Roll back to the last successful Deployment
oc rollout undo deploymentconfig/php
$ oc rollout undo deploymentconfig/phpExample: Start a new rollout for a DeploymentConfig with its latest state
oc rollout latest deploymentconfig/php
$ oc rollout latest deploymentconfig/php1.4.2.6. start-build
Start a build from a BuildConfig or copy an existing build.
Example: Start a build from the specified BuildConfig
oc start-build python
$ oc start-build pythonExample: Start a build from a previous build
oc start-build --from-build=python-1
$ oc start-build --from-build=python-1Example: Set an environment variable to use for the current build
oc start-build python --env=mykey=myvalue
$ oc start-build python --env=mykey=myvalue1.4.2.7. tag
Tag existing images into imagestreams.
Example: Configure the ruby image’s latest tag to refer to the image for the 2.0 tag
oc tag ruby:latest ruby:2.0
$ oc tag ruby:latest ruby:2.01.4.3. Application management CLI commands
1.4.3.1. annotate
Update the annotations on one or more resources.
Example: Add an annotation to a Route
oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"
$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"Example: Remove the annotation from the Route
oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-
$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-1.4.3.2. apply
Apply a configuration to a resource by file name or standard in (stdin) in JSON or YAML format.
Example: Apply the configuration in pod.json to a Pod
oc apply -f pod.json
$ oc apply -f pod.json1.4.3.3. autoscale
Autoscale a DeploymentConfig or ReplicationController.
Example: Autoscale to a minimum of two and maximum of five Pods
oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=5
$ oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=51.4.3.4. create
Create a resource by file name or standard in (stdin) in JSON or YAML format.
Example: Create a Pod using the content in pod.json
oc create -f pod.json
$ oc create -f pod.json1.4.3.5. delete
Delete a resource.
Example: Delete a Pod named parksmap-katacoda-1-qfqz4
oc delete pod/parksmap-katacoda-1-qfqz4
$ oc delete pod/parksmap-katacoda-1-qfqz4Example: Delete all Pods with the app=parksmap-katacoda label
oc delete pods -l app=parksmap-katacoda
$ oc delete pods -l app=parksmap-katacoda1.4.3.6. describe
Return detailed information about a specific object.
Example: Describe a Deployment named example
oc describe deployment/example
$ oc describe deployment/exampleExample: Describe all Pods
oc describe pods
$ oc describe pods1.4.3.7. edit
Edit a resource.
Example: Edit a DeploymentConfig using the default editor
oc edit deploymentconfig/parksmap-katacoda
$ oc edit deploymentconfig/parksmap-katacodaExample: Edit a DeploymentConfig using a different editor
OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacoda
$ OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacodaExample: Edit a DeploymentConfig in JSON format
oc edit deploymentconfig/parksmap-katacoda -o json
$ oc edit deploymentconfig/parksmap-katacoda -o json1.4.3.8. expose
Expose a Service externally as a Route.
Example: Expose a Service
oc expose service/parksmap-katacoda
$ oc expose service/parksmap-katacodaExample: Expose a Service and specify the host name
oc expose service/parksmap-katacoda --hostname=www.my-host.com
$ oc expose service/parksmap-katacoda --hostname=www.my-host.com1.4.3.9. get
Display one or more resources.
Example: List Pods in the default namespace
oc get pods -n default
$ oc get pods -n defaultExample: Get details about the python DeploymentConfig in JSON format
oc get deploymentconfig/python -o json
$ oc get deploymentconfig/python -o json1.4.3.10. label
Update the labels on one or more resources.
Example: Update the python-1-mz2rf Pod with the label status set to unhealthy
oc label pod/python-1-mz2rf status=unhealthy
$ oc label pod/python-1-mz2rf status=unhealthy1.4.3.11. scale
Set the desired number of replicas for a ReplicationController or a DeploymentConfig.
Example: Scale the ruby-app DeploymentConfig to three Pods
oc scale deploymentconfig/ruby-app --replicas=3
$ oc scale deploymentconfig/ruby-app --replicas=31.4.3.12. secrets
Manage secrets in your project.
Example: Allow my-pull-secret to be used as an image pull secret by the default service account
oc secrets link default my-pull-secret --for=pull
$ oc secrets link default my-pull-secret --for=pull1.4.3.13. serviceaccounts
Get a token assigned to a service account or create a new token or kubeconfig file for a service account.
Example: Get the token assigned to the default service account
oc serviceaccounts get-token default
$ oc serviceaccounts get-token default1.4.3.14. set
Configure existing application resources.
Example: Sets the name of a secret on a BuildConfig
oc set build-secret --source buildconfig/mybc mysecret
$ oc set build-secret --source buildconfig/mybc mysecret1.4.4. Troubleshooting and debugging CLI commands
1.4.4.1. attach
Attach the shell to a running container.
Example: Get output from the python container from Pod python-1-mz2rf
oc attach python-1-mz2rf -c python
$ oc attach python-1-mz2rf -c python1.4.4.2. cp
Copy files and directories to and from containers.
Example: Copy a file from the python-1-mz2rf Pod to the local file system
oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.
$ oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.1.4.4.3. debug
Launch a command shell to debug a running application.
Example: Debug the python Deployment
oc debug deploymentconfig/python
$ oc debug deploymentconfig/python1.4.4.4. exec
Execute a command in a container.
Example: Execute the ls command in the python container from Pod python-1-mz2rf
oc exec python-1-mz2rf -c python ls
$ oc exec python-1-mz2rf -c python ls1.4.4.5. logs
Retrieve the log output for a specific build, BuildConfig, DeploymentConfig, or Pod.
Example: Stream the latest logs from the python DeploymentConfig
oc logs -f deploymentconfig/python
$ oc logs -f deploymentconfig/python1.4.4.6. port-forward
Forward one or more local ports to a Pod.
Example: Listen on port 8888 locally and forward to port 5000 in the Pod
oc port-forward python-1-mz2rf 8888:5000
$ oc port-forward python-1-mz2rf 8888:50001.4.4.7. proxy
Run a proxy to the Kubernetes API server.
Example: Run a proxy to the API server on port 8011 serving static content from ./local/www/
oc proxy --port=8011 --www=./local/www/
$ oc proxy --port=8011 --www=./local/www/1.4.4.8. rsh
Open a remote shell session to a container.
Example: Open a shell session on the first container in the python-1-mz2rf Pod
oc rsh python-1-mz2rf
$ oc rsh python-1-mz2rf1.4.4.9. rsync
Copy contents of a directory to or from a running Pod container. Only changed files are copied using the rsync command from your operating system.
Example: Synchronize files from a local directory with a Pod directory
oc rsync ~/mydirectory/ python-1-mz2rf:/opt/app-root/src/
$ oc rsync ~/mydirectory/ python-1-mz2rf:/opt/app-root/src/1.4.4.10. run
Create and run a particular image. By default, this creates a DeploymentConfig to manage the created containers.
Example: Start an instance of the perl image with three replicas
oc run my-test --image=perl --replicas=3
$ oc run my-test --image=perl --replicas=31.4.4.11. wait
Wait for a specific condition on one or more resources.
Example: Wait for the python-1-mz2rf Pod to be deleted
oc wait --for=delete pod/python-1-mz2rf
$ oc wait --for=delete pod/python-1-mz2rf1.4.5. Advanced developer CLI commands
1.4.5.1. api-resources
Display the full list of API resources that the server supports.
Example: List the supported API resources
oc api-resources
$ oc api-resources1.4.5.2. api-versions
Display the full list of API versions that the server supports.
Example: List the supported API versions
oc api-versions
$ oc api-versions1.4.5.3. auth
Inspect permissions and reconcile RBAC roles.
Example: Check whether the current user can read Pod logs
oc auth can-i get pods --subresource=log
$ oc auth can-i get pods --subresource=logExample: Reconcile RBAC roles and permissions from a file
oc auth reconcile -f policy.json
$ oc auth reconcile -f policy.json1.4.5.4. cluster-info
Display the address of the master and cluster services.
Example: Display cluster information
oc cluster-info
$ oc cluster-info1.4.5.5. convert
Convert a YAML or JSON configuration file to a different API version and print to standard output (stdout).
Example: Convert pod.yaml to the latest version
oc convert -f pod.yaml
$ oc convert -f pod.yaml1.4.5.6. extract
Extract the contents of a ConfigMap or secret. Each key in the ConfigMap or secret is created as a separate file with the name of the key.
Example: Download the contents of the ruby-1-ca ConfigMap to the current directory
oc extract configmap/ruby-1-ca
$ oc extract configmap/ruby-1-caExample: Print the contents of the ruby-1-ca ConfigMap to stdout
oc extract configmap/ruby-1-ca --to=-
$ oc extract configmap/ruby-1-ca --to=-1.4.5.7. idle
Idle scalable resources. An idled Service will automatically become unidled when it receives traffic or it can be manually unidled using the oc scale command.
Example: Idle the ruby-app Service
oc idle ruby-app
$ oc idle ruby-app1.4.5.8. image
Manage images in your OpenShift Container Platform cluster.
Example: Copy an image to another tag
oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable
$ oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable1.4.5.9. observe
Observe changes to resources and take action on them.
Example: Observe changes to Services
oc observe services
$ oc observe services1.4.5.10. patch
Updates one or more fields of an object using strategic merge patch in JSON or YAML format.
Example: Update the spec.unschedulable field for node node1 to true
oc patch node/node1 -p '{"spec":{"unschedulable":true}}'
$ oc patch node/node1 -p '{"spec":{"unschedulable":true}}'
If you must patch a Custom Resource Definition, you must include the --type merge option in the command.
1.4.5.11. policy
Manage authorization policies.
Example: Add the edit role to user1 for the current project
oc policy add-role-to-user edit user1
$ oc policy add-role-to-user edit user11.4.5.12. process
Process a template into a list of resources.
Example: Convert template.json to a resource list and pass to oc create
oc process -f template.json | oc create -f -
$ oc process -f template.json | oc create -f -1.4.5.13. registry
Manage the integrated registry on OpenShift Container Platform.
Example: Display information about the integrated registry
oc registry info
$ oc registry info1.4.5.14. replace
Modify an existing object based on the contents of the specified configuration file.
Example: Update a Pod using the content in pod.json
oc replace -f pod.json
$ oc replace -f pod.json1.4.6. Settings CLI commands
1.4.6.1. completion
Output shell completion code for the specified shell.
Example: Display completion code for Bash
oc completion bash
$ oc completion bash1.4.6.2. config
Manage the client configuration files.
Example: Display the current configuration
oc config view
$ oc config viewExample: Switch to a different context
oc config use-context test-context
$ oc config use-context test-context1.4.6.3. logout
Log out of the current session.
Example: End the current session
oc logout
$ oc logout1.4.6.4. whoami
Display information about the current session.
Example: Display the currently authenticated user
oc whoami
$ oc whoami1.4.7. Other developer CLI commands
1.4.7.1. help
Display general help information for the CLI and a list of available commands.
Example: Display available commands
oc help
$ oc helpExample: Display the help for the new-project command
oc help new-project
$ oc help new-project1.4.7.2. plugin
List the available plug-ins on the user’s PATH.
Example: List available plug-ins
oc plugin list
$ oc plugin list1.4.7.3. version
Display the oc client and server versions.
Example: Display version information
oc version
$ oc versionFor cluster administrators, the OpenShift Container Platform server version is also displayed.
1.5. Administrator CLI commands
1.5.1. Cluster management CLI commands
1.5.1.1. must-gather
Bulk collect data about the current state of your cluster to debug issues.
Example: Gather debugging information
oc adm must-gather
$ oc adm must-gather1.5.1.2. top
Show usage statistics of resources on the server.
Example: Show CPU and memory usage for Pods
oc adm top pods
$ oc adm top podsExample: Show usage statistics for images
oc adm top images
$ oc adm top images1.5.2. Node management CLI commands
1.5.2.1. cordon
Mark a node as unschedulable. Manually marking a node as unschedulable blocks any new pods from being scheduled on the node, but does not affect existing pods on the node.
Example: Mark node1 as unschedulable
oc adm cordon node1
$ oc adm cordon node11.5.2.2. drain
Drain a node in preparation for maintenance.
Example: Drain node1
oc adm drain node1
$ oc adm drain node11.5.2.3. node-logs
Display and filter node logs.
Example: Get logs for NetworkManager
oc adm node-logs --role master -u NetworkManager.service
$ oc adm node-logs --role master -u NetworkManager.service1.5.2.4. taint
Update the taints on one or more nodes.
Example: Add a taint to dedicate a node for a set of users
oc adm taint nodes node1 dedicated=groupName:NoSchedule
$ oc adm taint nodes node1 dedicated=groupName:NoScheduleExample: Remove the taints with key dedicated from node node1
oc adm taint nodes node1 dedicated-
$ oc adm taint nodes node1 dedicated-1.5.2.5. uncordon
Mark a node as schedulable.
Example: Mark node1 as schedulable
oc adm uncordon node1
$ oc adm uncordon node11.5.3. Security and policy CLI commands
1.5.3.1. certificate
Approve or reject certificate signing requests (CSRs).
Example: Approve a CSR
oc adm certificate approve csr-sqgzp
$ oc adm certificate approve csr-sqgzp1.5.3.2. groups
Manage groups in your cluster.
Example: Create a new group
oc adm groups new my-group
$ oc adm groups new my-group1.5.3.3. new-project
Create a new project and specify administrative options.
Example: Create a new project using a node selector
oc adm new-project myproject --node-selector='type=user-node,region=east'
$ oc adm new-project myproject --node-selector='type=user-node,region=east'1.5.3.4. pod-network
Manage Pod networks in the cluster.
Example: Isolate project1 and project2 from other non-global projects
oc adm pod-network isolate-projects project1 project2
$ oc adm pod-network isolate-projects project1 project21.5.3.5. policy
Manage roles and policies on the cluster.
Example: Add the edit role to user1 for all projects
oc adm policy add-cluster-role-to-user edit user1
$ oc adm policy add-cluster-role-to-user edit user1Example: Add the privileged security context constraint to a service account
oc adm policy add-scc-to-user privileged -z myserviceaccount
$ oc adm policy add-scc-to-user privileged -z myserviceaccount1.5.4. Maintenance CLI commands
1.5.4.1. migrate
Migrate resources on the cluster to a new version or format depending on the subcommand used.
Example: Perform an update of all stored objects
oc adm migrate storage
$ oc adm migrate storageExample: Perform an update of only Pods
oc adm migrate storage --include=pods
$ oc adm migrate storage --include=pods1.5.4.2. prune
Remove older versions of resources from the server.
Example: Prune older builds including those whose BuildConfigs no longer exist
oc adm prune builds --orphans
$ oc adm prune builds --orphans1.5.5. Configuration CLI commands
1.5.5.1. create-api-client-config
Create a client configuration for connecting to the server. This creates a folder containing a client certificate, a client key, a server certificate authority, and a kubeconfig file for connecting to the master as the provided user.
Example: Generate a client certificate for a proxy
1.5.5.2. create-bootstrap-policy-file
Create the default bootstrap policy.
Example: Create a file called policy.json with the default bootstrap policy
oc adm create-bootstrap-policy-file --filename=policy.json
$ oc adm create-bootstrap-policy-file --filename=policy.json1.5.5.3. create-bootstrap-project-template
Create a bootstrap project template.
Example: Output a bootstrap project template in YAML format to stdout
oc adm create-bootstrap-project-template -o yaml
$ oc adm create-bootstrap-project-template -o yaml1.5.5.4. create-error-template
Create a template for customizing the error page.
Example: Output a template for the error page to stdout
oc adm create-error-template
$ oc adm create-error-template1.5.5.5. create-kubeconfig
Creates a basic .kubeconfig file from client certificates.
Example: Create a .kubeconfig file with the provided client certificates
oc adm create-kubeconfig \ --client-certificate=/path/to/client.crt \ --client-key=/path/to/client.key \ --certificate-authority=/path/to/ca.crt
$ oc adm create-kubeconfig \
--client-certificate=/path/to/client.crt \
--client-key=/path/to/client.key \
--certificate-authority=/path/to/ca.crt1.5.5.6. create-login-template
Create a template for customizing the login page.
Example: Output a template for the login page to stdout
oc adm create-login-template
$ oc adm create-login-template1.5.5.7. create-provider-selection-template
Create a template for customizing the provider selection page.
Example: Output a template for the provider selection page to stdout
oc adm create-provider-selection-template
$ oc adm create-provider-selection-template1.5.6. Other Administrator CLI commands
1.5.6.1. build-chain
Output the inputs and dependencies of any builds.
Example: Output dependencies for the perl imagestream
oc adm build-chain perl
$ oc adm build-chain perl1.5.6.2. completion
Output shell completion code for the oc adm commands for the specified shell.
Example: Display oc adm completion code for Bash
oc adm completion bash
$ oc adm completion bash1.5.6.3. config
Manage the client configuration files. This command has the same behavior as the oc config command.
Example: Display the current configuration
oc adm config view
$ oc adm config viewExample: Switch to a different context
oc adm config use-context test-context
$ oc adm config use-context test-context1.5.6.4. release
Manage various aspects of the OpenShift Container Platform release process, such as viewing information about a release or inspecting the contents of a release.
Example: Generate a changelog between two releases and save to changelog.md
oc adm release info --changelog=/tmp/git \
quay.io/openshift-release-dev/ocp-release:4.2.0-rc.7 \
quay.io/openshift-release-dev/ocp-release:4.2.0 \
> changelog.md
$ oc adm release info --changelog=/tmp/git \
quay.io/openshift-release-dev/ocp-release:4.2.0-rc.7 \
quay.io/openshift-release-dev/ocp-release:4.2.0 \
> changelog.md1.5.6.5. verify-image-signature
Verify the image signature of an image imported to the internal registry using the local public GPG key.
Example: Verify the nodejs image signature
oc adm verify-image-signature \
sha256:2bba968aedb7dd2aafe5fa8c7453f5ac36a0b9639f1bf5b03f95de325238b288 \
--expected-identity 172.30.1.1:5000/openshift/nodejs:latest \
--public-key /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release \
--save
$ oc adm verify-image-signature \
sha256:2bba968aedb7dd2aafe5fa8c7453f5ac36a0b9639f1bf5b03f95de325238b288 \
--expected-identity 172.30.1.1:5000/openshift/nodejs:latest \
--public-key /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release \
--save1.6. Usage of oc and kubectl commands
Kubernetes' command line interface (CLI), kubectl, can be used to run commands against a Kubernetes cluster. Because OpenShift Container Platform is a certified Kubernetes distribution, you can use the supported kubectl binaries that ship with OpenShift Container Platform, or you can gain extended functionality by using the oc binary.
1.6.1. The oc binary
The oc binary offers the same capabilities as the kubectl binary, but it extends to natively support additional OpenShift Container Platform features, including:
Full support for OpenShift Container Platform resources
Resources such as DeploymentConfigs, BuildConfigs, Routes, ImageStreams, and ImageStreamTags are specific to OpenShift Container Platform distributions, and build upon standard Kubernetes primitives.
Authentication
The
ocbinary offers a built-inlogincommand that allows authentication and enables you to work with OpenShift Container Platform projects, which map Kubernetes namespaces to authenticated users. See Understanding authentication for more information.Additional commands
The additional command
oc new-app, for example, makes it easier to get new applications started using existing source code or pre-built images. Similarly, the additional commandoc new-projectmakes it easier to start a project that you can switch to as your default.
1.6.2. The kubectl binary
The kubectl binary is provided as a means to support existing workflows and scripts for new OpenShift Container Platform users coming from a standard Kubernetes environment, or for those who prefer to use the kubectl CLI. Existing users of kubectl can continue to use the binary to interact with Kubernetes primitives, with no changes required to the OpenShift Container Platform cluster.
For more information, see the kubectl docs.
Chapter 2. OpenShift Do developer CLI (odo)
2.1. Understanding OpenShift Do
OpenShift Do (odo) is a fast and easy-to-use CLI tool for creating applications on OpenShift Container Platform. odo allows developers to concentrate on creating applications without the need to administrate an OpenShift Container Platform cluster itself. Creating deployment configurations, build configurations, service routes and other OpenShift Container Platform elements are all automated by odo.
Existing tools such as oc are more operations-focused and require a deep understanding of Kubernetes and OpenShift Container Platform concepts. odo abstracts away complex Kubernetes and OpenShift Container Platform concepts allowing developers to focus on what is most important to them: code.
2.1.1. Key features
odo is designed to be simple and concise with the following key features:
- Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.
- Completely client based. No additional server other than OpenShift Container Platform is required for deployment.
- Official support for Node.js and Java components.
- Partial compatibility with languages and frameworks such as Ruby, Perl, PHP, and Python.
- Detects changes to local code and deploys it to the cluster automatically, giving instant feedback to validate changes in real time.
- Lists all the available components and services from the OpenShift Container Platform cluster.
2.1.2. Core concepts
- Project
- A project is your source code, tests, and libraries organized in a separate single unit.
- Application
- An application is a program designed for end users. An application consists of multiple microservices or components that work individually to build the entire application. Examples of applications: a video game, a media player, a web browser.
- Component
- A component is a set of Kubernetes resources which host code or data. Each component can be run and deployed separately. Examples of components: Node.js, Perl, PHP, Python, Ruby.
- Service
-
A service is software that your component links to or depends on. Examples of services: MariaDB, Jenkins, MySQL. In
odo, services are provisioned from the OpenShift Service Catalog and must be enabled within your cluster.
2.1.2.1. Officially supported languages and corresponding container images
| Language | Container image | Package manager |
|---|---|---|
| Node.js | NPM | |
| NPM | ||
| NPM | ||
| NPM | ||
| NPM | ||
| Java | Maven, Gradle | |
| Maven, Gradle | ||
| Maven, Gradle |
2.1.2.1.1. Listing available container images
The list of available container images is sourced from the cluster’s internal container registry and external registries associated with the cluster.
To list the available components and associated container images for your cluster:
Log in to the OpenShift Container Platform cluster with
odo:odo login -u developer -p developer
$ odo login -u developer -p developerCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the available
odosupported and unsupported components and corresponding container images:Copy to Clipboard Copied! Toggle word wrap Toggle overflow The
TAGScolumn represents the available image versions, for example,10represents therhoar-nodejs/nodejs-10container image.
2.2. odo architecture
This section describes odo architecture and how odo manages OpenShift Container Platform resources on a cluster.
2.2.1. Developer setup
With odo you can create and deploy application on OpenShift Container Platform clusters from a terminal. Code editor plug-ins use odo which allows users to interact with OpenShift Container Platform clusters from their IDE terminals. Examples of plug-ins that use odo: VS Code Openshift Connector, Openshift Connector for Intellij, Codewind for Eclipse Che.
odo works on Windows, macOS, and Linux operating systems and from any terminal. odo provides autocompletion for bash and zsh command line shells.
odo 1.0 supports Node.js and Java components.
2.2.2. OpenShift source-to-image
Openshift Source-to-Image (S2I) is an open-source project which helps in building artifacts from source code and injecting these into container images. S2I produces ready-to-run images by building source code without the need of a Dockerfile. odo uses S2I builder image for executing developer source code inside a container.
2.2.3. OpenShift cluster objects
2.2.3.1. Init Containers
Init containers are specialized containers that run before the application container starts and configure the necessary environment for the application containers to run. Init containers can have files that application images do not have, for example setup scripts. Init containers always run to completion and the application container does not start if any of the init containers fails.
The Pod created by odo executes two Init Containers:
-
The
copy-supervisordInit container. -
The
copy-files-to-volumeInit container.
2.2.3.1.1. copy-supervisord
The copy-supervisord Init container copies necessary files onto an emptyDir Volume. The main application container utilizes these files from the emptyDir Volume.
Files that are copied onto the emptyDir Volume:
Binaries:
-
go-initis a minimal init system. It runs as the first process (PID 1) inside the application container. go-init starts theSupervisorDdaemon which runs the developer code. go-init is required to handle orphaned processes. -
SupervisorDis a process control system. It watches over configured processes and ensures that they are running. It also restarts services when necessary. For odo,SupervisorDexecutes and monitors the developer code.
-
Configuration files:
-
supervisor.confis the configuration file necessary for the SupervisorD daemon to start.
-
Scripts:
-
assemble-and-restartis an OpenShift S2I concept to build and deploy user-source code. The assemble-and-restart script first assembles the user source code inside the application container and then restarts SupervisorD for user changes to take effect. -
Runis an OpenShift S2I concept of executing the assembled source code. Therunscript executes the assembled code created by theassemble-and-restartscript. -
s2i-setupis a script that creates files and directories which are necessary for theassemble-and-restartand run scripts to execute successfully. The script is executed whenever the application container starts.
-
Directories:
-
language-scripts: Openshift S2I allows customassembleandrunscripts. A few language specific custom scripts are present in thelanguage-scriptsdirectory. The custom scripts provide additional configuration to make odo debug work.
-
The emtpyDir Volume is mounted at the /opt/odo mount point for both the Init container and the application container.
2.2.3.1.2. copy-files-to-volume
The copy-files-to-volume Init container copies files that are in /opt/app-root in the S2I builder image onto the Persistent Volume. The volume is then mounted at the same location (/opt/app-root) in an application container.
Without the PersistentVolume on /opt/app-root the data in this directory is lost when PersistentVolumeClaim is mounted at the same location.
The PVC is mounted at the /mnt mount point inside the Init container.
2.2.3.2. Application container
Application container is the main container inside of which the user-source code executes.
Application container is mounted with two Volumes:
-
emptyDirVolume mounted at/opt/odo -
The
PersistentVolumemounted at/opt/app-root
go-init is executed as the first process inside the application container. The go-init process then starts the SupervisorD daemon.
SupervisorD executes and monitores the user assembled source code. If the user process crashes, SupervisorD restarts it.
2.2.3.3. PersistentVolume and PersistentVolumeClaim
PersistentVolumeClaim (PVC) is a volume type in Kubernetes which provisions a PersistentVolume. The life of a PersistentVolume is independent of a Pod lifecycle. The data on the PersistentVolume persists across Pod restarts.
The copy-files-to-volume Init container copies necessary files onto the PersistentVolume. The main application container utilizes these files at runtime for execution.
The naming convention of the PersistentVolume is <component-name>-s2idata.
| Container | PVC Mounted at |
|---|---|
|
|
|
| Application container |
|
2.2.3.4. emptyDir Volume
An emptyDir Volume is created when a Pod is assigned to a node, and exists as long as that Pod is running on the node. If the container is restarted or moved, the content of the emptyDir is removed, Init container restores the data back to the emptyDir. emptyDir is initially empty.
The copy-supervisord Init container copies necessary files onto the emptyDir volume. These files are then utilized by the main application container at runtime for execution.
| Container | emptyDir Volume Mounted at |
|---|---|
|
|
|
| Application container |
|
2.2.3.5. Service
Service is a Kubernetes concept of abstracting the way of communicating with a set of Pods.
odo creates a Service for every application Pod to make it accessible for communication.
2.2.4. odo push workflow
This section describes odo push workflow. odo push deploys user code on an OpenShift Container Platform cluster with all the necessary OpenShift Container Platform resources.
Creating resources
If not already created,
odo pushcreates the following OpenShift Container Platform resources:Deployment config (DC):
-
Two init containers are executed:
copy-supervisordandcopy-files-to-volume. The init containers copy files onto theemptyDirand thePersistentVolumetype of volumes respectively. -
The application container starts. The first process in the application container is the
go-initprocess with PID=1. go-initprocess starts the SupervisorD daemon.NoteThe user application code has not been copied into the application container yet, so the
SupervisorDdaemon does not execute therunscript.
-
Two init containers are executed:
- Service
- Secrets
-
PersistentVolumeClaim
Indexing files
- A file indexer indexes the files in the source code directory. The indexer traverses through the source code directories recursively and finds files which have been created, deleted, or renamed.
-
A file indexer maintains the indexed information in an odo index file inside the
.ododirectory. - If the odo index file is not present, it means that the file indexer is being executed for the first time, and creates a new odo index JSON file. The odo index JSON file contains a file map - the relative file paths of the traversed files and the absolute paths of the changed and deleted files.
Pushing code
Local code is copied into the application container, usually under
/tmp/src.Executing
assemble-and-restartOn a successful copy of the source code, the
assemble-and-restartscript is executed inside the running application container.
2.3. Installing odo
The following section describes how to install odo on different platforms.
Currently, odo does not support installation in a restricted network environment.
2.3.1. Installing odo on Linux
2.3.1.1. Binary installation
curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o /usr/local/bin/odo chmod +x /usr/local/bin/odo
# curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o /usr/local/bin/odo
# chmod +x /usr/local/bin/odo2.3.1.2. Tarball installation
sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz | gzip -d > /usr/local/bin/odo' chmod +x /usr/local/bin/odo
# sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz | gzip -d > /usr/local/bin/odo'
# chmod +x /usr/local/bin/odo2.3.2. Installing odo on Windows
2.3.2.1. Binary installation
-
Download the latest
odo.exefile. -
Add the location of your
odo.exeto yourGOPATH/bindirectory.
Setting the PATH variable for Windows 7/8
The following example demonstrates how to set up a path variable. Your binaries can be located in any location, but this example uses C:\go-bin as the location.
-
Create a folder at
C:\go-bin. - Right click Start and click Control Panel.
- Select System and Security and then click System.
- From the menu on the left, select the Advanced systems settings and click the Environment Variables button at the bottom.
- Select Path from the Variable section and click Edit.
-
Click New and type
C:\go-bininto the field or click Browse and select the directory, and click OK.
Setting the PATH variable for Windows 10
Edit Environment Variables using search:
-
Click Search and type
envorenvironment. - Select Edit environment variables for your account.
- Select Path from the Variable section and click Edit.
-
Click New and type
C:\go-bininto the field or click Browse and select the directory, and click OK.
2.3.3. Installing odo on macOS
2.3.3.1. Binary installation
curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o /usr/local/bin/odo chmod +x /usr/local/bin/odo
# curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o /usr/local/bin/odo
# chmod +x /usr/local/bin/odo2.3.3.2. Tarball installation
sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz | gzip -d > /usr/local/bin/odo' chmod +x /usr/local/bin/odo
# sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz | gzip -d > /usr/local/bin/odo'
# chmod +x /usr/local/bin/odo2.4. Using odo in a restricted environment
2.4.1. About odo in a restricted environment
To run odo in a disconnected OpenShift Container Platform cluster or a cluster provisioned in a restricted environment, you must ensure that a cluster administrator has created a cluster with a mirrored registry.
To start working in a disconnected cluster, you must first push the odo init image to the registry of the cluster and then overwrite the odo init image path using the ODO_BOOTSTRAPPER_IMAGE environment variable.
After you push the odo init image, you must mirror a supported builder image from the registry, overwrite a mirror registry and then create your application. A builder image is necessary to configure a runtime environment for your application and also contains the build tool needed to build your application, for example npm for Node.js or Maven for Java. A mirror registry contains all the necessary dependencies for your application.
2.4.2. Pushing the odo init image to the restricted cluster registry
Depending on the configuration of your cluster and your operating system you can either push the odo init image to a mirror registry or directly to an internal registry.
Prerequisites
-
Install
ocon the client operating system. -
Install
odoon the client operating system. - Access to an OpenShift Container Platform restricted cluster with a configured internal registry or a mirror registry.
2.4.2.1. Pushing the odo init image to a mirror registry
Depending on your operating system, you can push the odo init image to a cluster with a mirror registry as follows:
2.4.2.1.1. Pushing the init image to a mirror registry on Linux
Procedure
Use
base64to encode the root certification authority (CA) content of your mirror registry:echo <content_of_additional_ca> | base64 -d > disconnect-ca.crt
$ echo <content_of_additional_ca> | base64 -d > disconnect-ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy the encoded root CA certificate to the appropriate location:
sudo cp ./disconnect-ca.crt /etc/pki/ca-trust/source/anchors/<mirror-registry>.crt
$ sudo cp ./disconnect-ca.crt /etc/pki/ca-trust/source/anchors/<mirror-registry>.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Trust a CA in your client platform and log into the OpenShift Container Platform mirror registry:
sudo update-ca-trust enable && sudo systemctl daemon-reload && sudo systemctl restart / docker && docker login <mirror-registry>:5000 -u <username> -p <password>
$ sudo update-ca-trust enable && sudo systemctl daemon-reload && sudo systemctl restart / docker && docker login <mirror-registry>:5000 -u <username> -p <password>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Mirror the
odo initimage:oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
$ oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Override the default
odo initimage path by setting theODO_BOOTSTRAPPER_IMAGEenvironment variable:export ODO_BOOTSTRAPPER_IMAGE=<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
$ export ODO_BOOTSTRAPPER_IMAGE=<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.2.1.2. Pushing the init image to a mirror registry on MacOS
Procedure
Use
base64to encode the root certification authority (CA) content of your mirror registry:echo <content_of_additional_ca> | base64 -d > disconnect-ca.crt
$ echo <content_of_additional_ca> | base64 -d > disconnect-ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy the encoded root CA certificate to the appropriate location:
- Restart Docker using the Docker UI.
Run the following command:
docker login <mirror-registry>:5000 -u <username> -p <password>
$ docker login <mirror-registry>:5000 -u <username> -p <password>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Mirror the
odo initimage:oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
$ oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Override the default
odo initimage path by setting theODO_BOOTSTRAPPER_IMAGEenvironment variable:export ODO_BOOTSTRAPPER_IMAGE=<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
$ export ODO_BOOTSTRAPPER_IMAGE=<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.2.1.3. Pushing the init image to a mirror registry on Windows
Procedure
Use
base64to encode the root certification authority (CA) content of your mirror registry:PS C:\> echo <content_of_additional_ca> | base64 -d > disconnect-ca.crt
PS C:\> echo <content_of_additional_ca> | base64 -d > disconnect-ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow As an administrator, copy the encoded root CA certificate to the appropriate location by executing the following command:
PS C:\WINDOWS\system32> certutil -addstore -f "ROOT" disconnect-ca.crt
PS C:\WINDOWS\system32> certutil -addstore -f "ROOT" disconnect-ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Trust a CA in your client platform and log into the OpenShift Container Platform mirror registry:
- Restart Docker using the Docker UI.
Run the following command:
PS C:\WINDOWS\system32> docker login <mirror-registry>:5000 -u <username> -p <password>
PS C:\WINDOWS\system32> docker login <mirror-registry>:5000 -u <username> -p <password>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Mirror the
odo initimage:PS C:\> oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
PS C:\> oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Override the default
odo initimage path by setting theODO_BOOTSTRAPPER_IMAGEenvironment variable:PS C:\> $env:ODO_BOOTSTRAPPER_IMAGE="<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>"
PS C:\> $env:ODO_BOOTSTRAPPER_IMAGE="<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.2.2. Pushing the odo init image to an internal registry directly
If your cluster allows images to be pushed to the internal registry directly, push the odo init image to the registry as follows:
2.4.2.2.1. Pushing the init image directly on Linux
Procedure
Enable the default route:
oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registry$ oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registryCopy to Clipboard Copied! Toggle word wrap Toggle overflow Get a wildcard route CA:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Use
base64to encode the root certification authority (CA) content of your mirror registry:echo <tls.crt> | base64 -d > ca.crt
$ echo <tls.crt> | base64 -d > ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Trust a CA in your client platform:
sudo cp ca.crt /etc/pki/ca-trust/source/anchors/externalroute.crt && sudo update-ca-trust enable && sudo systemctl daemon-reload && sudo systemctl restart docker
$ sudo cp ca.crt /etc/pki/ca-trust/source/anchors/externalroute.crt && sudo update-ca-trust enable && sudo systemctl daemon-reload && sudo systemctl restart dockerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Log into the internal registry:
oc get route -n openshift-image-registry docker login <registry_path> -u kubeadmin -p $(oc whoami -t)
$ oc get route -n openshift-image-registry NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD default-route <registry_path> image-registry <all> reencrypt None $ docker login <registry_path> -u kubeadmin -p $(oc whoami -t)Copy to Clipboard Copied! Toggle word wrap Toggle overflow Push the
odo initimage:docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag> docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>
$ docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> $ docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag> $ docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Override the default
odo initimage path by setting theODO_BOOTSTRAPPER_IMAGEenvironment variable:export ODO_BOOTSTRAPPER_IMAGE=<registry_path>/openshiftdo/odo-init-image-rhel7:1.0.1
$ export ODO_BOOTSTRAPPER_IMAGE=<registry_path>/openshiftdo/odo-init-image-rhel7:1.0.1Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.2.2.2. Pushing the init image directly on MacOS
Procedure
Enable the default route:
oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registry$ oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registryCopy to Clipboard Copied! Toggle word wrap Toggle overflow Get a wildcard route CA:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Use
base64to encode the root certification authority (CA) content of your mirror registry:echo <tls.crt> | base64 -d > ca.crt
$ echo <tls.crt> | base64 -d > ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Trust a CA in your client platform:
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain ca.crt
$ sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Log into the internal registry:
oc get route -n openshift-image-registry docker login <registry_path> -u kubeadmin -p $(oc whoami -t)
$ oc get route -n openshift-image-registry NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD default-route <registry_path> image-registry <all> reencrypt None $ docker login <registry_path> -u kubeadmin -p $(oc whoami -t)Copy to Clipboard Copied! Toggle word wrap Toggle overflow Push the
odo initimage:docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag> docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>
$ docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> $ docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag> $ docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Override the default
odo initimage path by setting theODO_BOOTSTRAPPER_IMAGEenvironment variable:export ODO_BOOTSTRAPPER_IMAGE=<registry_path>/openshiftdo/odo-init-image-rhel7:1.0.1
$ export ODO_BOOTSTRAPPER_IMAGE=<registry_path>/openshiftdo/odo-init-image-rhel7:1.0.1Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.2.2.3. Pushing the init image directly on Windows
Procedure
Enable the default route:
PS C:\> oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registryPS C:\> oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registryCopy to Clipboard Copied! Toggle word wrap Toggle overflow Get a wildcard route CA:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Use
base64to encode the root certification authority (CA) content of your mirror registry:PS C:\> echo <tls.crt> | base64 -d > ca.crt
PS C:\> echo <tls.crt> | base64 -d > ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow As an administrator, trust a CA in your client platform by executing the following command:
PS C:\WINDOWS\system32> certutil -addstore -f "ROOT" ca.crt
PS C:\WINDOWS\system32> certutil -addstore -f "ROOT" ca.crtCopy to Clipboard Copied! Toggle word wrap Toggle overflow Log into the internal registry:
PS C:\> oc get route -n openshift-image-registry NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD default-route <registry_path> image-registry <all> reencrypt None PS C:\> docker login <registry_path> -u kubeadmin -p $(oc whoami -t)
PS C:\> oc get route -n openshift-image-registry NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD default-route <registry_path> image-registry <all> reencrypt None PS C:\> docker login <registry_path> -u kubeadmin -p $(oc whoami -t)Copy to Clipboard Copied! Toggle word wrap Toggle overflow Push the
odo initimage:PS C:\> docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> PS C:\> docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag> PS C:\> docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>
PS C:\> docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> PS C:\> docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag> PS C:\> docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Override the default
odo initimage path by setting theODO_BOOTSTRAPPER_IMAGEenvironment variable:PS C:\> $env:ODO_BOOTSTRAPPER_IMAGE="<registry_path>/openshiftdo/odo-init-image-rhel7:<tag>"
PS C:\> $env:ODO_BOOTSTRAPPER_IMAGE="<registry_path>/openshiftdo/odo-init-image-rhel7:<tag>"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.3. Creating and deploying a component to the disconnected cluster
After you push the init image to a cluster with a mirrored registry, you must mirror a supported builder image for your application with the oc tool, overwrite the mirror registry using the environment variable, and then create your component.
Prerequisites
-
Install
ocon the client operating system. -
Install
odoon the client operating system. - Access to an OpenShift Container Platform restricted cluster with a configured internal registry or a mirror registry.
-
Push the
odo initimage to your cluster registry.
2.4.3.1. Mirroring a supported builder image
To use npm packages for Node.js dependencies and Maven packages for Java dependencies and configure a runtime environment for your application, you must mirror a respective builder image from the mirror registry.
Procedure
Verify that the required images tag is not imported:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Mirror the supported image tag to the private registry:
oc image mirror registry.access.redhat.com/rhscl/nodejs-10-rhel7:<tag> <private_registry>/rhscl/nodejs-10-rhel7:<tag>
$ oc image mirror registry.access.redhat.com/rhscl/nodejs-10-rhel7:<tag> <private_registry>/rhscl/nodejs-10-rhel7:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Import the image:
oc tag <mirror-registry>:<port>/rhscl/nodejs-10-rhel7:<tag> nodejs-10-rhel7:latest --scheduled
$ oc tag <mirror-registry>:<port>/rhscl/nodejs-10-rhel7:<tag> nodejs-10-rhel7:latest --scheduledCopy to Clipboard Copied! Toggle word wrap Toggle overflow You must periodically re-import the image. The
--scheduledflag enables automatic re-import of the image.Verify that the images with the given tag have been imported:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.3.2. Overwriting the mirror registry
To download npm packages for Node.js dependencies and Maven packages for Java dependencies from a private mirror registry, you must create and configure a mirror npm or Maven registry on the cluster. You can then overwrite the mirror registry on an existing component or when you create a new component.
Procedure
To overwrite the mirror registry on an existing component:
odo config set --env NPM_MIRROR=<npm_mirror_registry>
$ odo config set --env NPM_MIRROR=<npm_mirror_registry>Copy to Clipboard Copied! Toggle word wrap Toggle overflow To overwrite the mirror registry when creating a component:
odo component create nodejs --env NPM_MIRROR=<npm_mirror_registry>
$ odo component create nodejs --env NPM_MIRROR=<npm_mirror_registry>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.3.3. Creating a Node.js application with odo
To create a Node.js component, download the Node.js application and push the source code to your cluster with odo.
Procedure
Change the current directory to the directory with your application:
cd <directory name>
$ cd <directory name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add a component of the type Node.js to your application:
odo create nodejs
$ odo create nodejsCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteBy default, the latest image is used. You can also explicitly specify an image version by using
odo create openshift/nodejs:8.Push the initial source code to the component:
odo push
$ odo pushCopy to Clipboard Copied! Toggle word wrap Toggle overflow Your component is now deployed to OpenShift Container Platform.
Create a URL and add an entry in the local configuration file as follows:
odo url create --port 8080
$ odo url create --port 8080Copy to Clipboard Copied! Toggle word wrap Toggle overflow Push the changes. This creates a URL on the cluster.
odo push
$ odo pushCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the URLs to check the desired URL for the component.
odo url list
$ odo url listCopy to Clipboard Copied! Toggle word wrap Toggle overflow View your deployed application using the generated URL.
curl <URL>
$ curl <URL>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5. Creating a single-component application with odo
With odo, you can create and deploy applications on OpenShift Container Platform clusters.
Prerequisites
-
odois installed. - You have a running OpenShift Container Platform cluster. You can use CodeReady Containers (CRC) to deploy a local OpenShift Container Platform cluster quickly.
2.5.1. Creating a project
Create a project to keep your source code, tests, and libraries organized in a separate single unit.
Procedure
Log in to an OpenShift Container Platform cluster:
odo login -u developer -p developer
$ odo login -u developer -p developerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a project:
odo project create myproject
$ odo project create myproject ✓ Project 'myproject' is ready for use ✓ New project created and now using project : myprojectCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5.2. Creating a Node.js application with odo
To create a Node.js component, download the Node.js application and push the source code to your cluster with odo.
Procedure
Create a directory for your components:
mkdir my_components $$ cd my_components
$ mkdir my_components $$ cd my_componentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Download the example Node.js application:
git clone https://github.com/openshift/nodejs-ex
$ git clone https://github.com/openshift/nodejs-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow Change the current directory to the directory with your application:
cd <directory name>
$ cd <directory name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add a component of the type Node.js to your application:
odo create nodejs
$ odo create nodejsCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteBy default, the latest image is used. You can also explicitly specify an image version by using
odo create openshift/nodejs:8.Push the initial source code to the component:
odo push
$ odo pushCopy to Clipboard Copied! Toggle word wrap Toggle overflow Your component is now deployed to OpenShift Container Platform.
Create a URL and add an entry in the local configuration file as follows:
odo url create --port 8080
$ odo url create --port 8080Copy to Clipboard Copied! Toggle word wrap Toggle overflow Push the changes. This creates a URL on the cluster.
odo push
$ odo pushCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the URLs to check the desired URL for the component.
odo url list
$ odo url listCopy to Clipboard Copied! Toggle word wrap Toggle overflow View your deployed application using the generated URL.
curl <URL>
$ curl <URL>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5.3. Modifying your application code
You can modify your application code and have the changes applied to your application on OpenShift Container Platform.
- Edit one of the layout files within the Node.js directory with your preferred text editor.
Update your component:
odo push
$ odo pushCopy to Clipboard Copied! Toggle word wrap Toggle overflow - Refresh your application in the browser to see the changes.
2.5.4. Adding storage to the application components
Persistent storage keeps data available between restarts of odo. You can add storage to your components with the odo storage command.
Procedure
Add storage to your components:
odo storage create nodestorage --path=/opt/app-root/src/storage/ --size=1Gi
$ odo storage create nodestorage --path=/opt/app-root/src/storage/ --size=1GiCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Your component now has 1 GB storage.
2.5.5. Adding a custom builder to specify a build image
With OpenShift Container Platform, you can add a custom image to bridge the gap between the creation of custom images.
The following example demonstrates the successful import and use of the redhat-openjdk-18 image:
Prerequisites
- The OpenShift CLI (oc) is installed.
Procedure
Import the image into OpenShift Container Platform:
oc import-image openjdk18 \ --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift \ --confirm
$ oc import-image openjdk18 \ --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift \ --confirmCopy to Clipboard Copied! Toggle word wrap Toggle overflow Tag the image to make it accessible to odo:
oc annotate istag/openjdk18:latest tags=builder
$ oc annotate istag/openjdk18:latest tags=builderCopy to Clipboard Copied! Toggle word wrap Toggle overflow Deploy the image with odo:
odo create openjdk18 --git \ https://github.com/openshift-evangelists/Wild-West-Backend
$ odo create openjdk18 --git \ https://github.com/openshift-evangelists/Wild-West-BackendCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5.6. Connecting your application to multiple services using OpenShift Service Catalog
The OpenShift service catalog is an implementation of the Open Service Broker API (OSB API) for Kubernetes. You can use it to connect applications deployed in OpenShift Container Platform to a variety of services.
Prerequisites
- You have a running OpenShift Container Platform cluster.
- The service catalog is installed and enabled on your cluster.
Procedure
To list the services:
odo catalog list services
$ odo catalog list servicesCopy to Clipboard Copied! Toggle word wrap Toggle overflow To use service catalog-related operations:
odo service <verb> <servicename>
$ odo service <verb> <servicename>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.5.7. Deleting an application
Deleting an application will delete all components associated with the application.
Procedure
List the applications in the current project:
odo app list
$ odo app list The project '<project_name>' has the following applications: NAME appCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the components associated with the applications. These components will be deleted with the application:
odo component list
$ odo component list APP NAME TYPE SOURCE STATE app nodejs-nodejs-ex-elyf nodejs file://./ PushedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the application:
odo app delete <application_name>
$ odo app delete <application_name> ? Are you sure you want to delete the application: <application_name> from project: <project_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Confirm the deletion with
Y. You can suppress the confirmation prompt using the-fflag.
2.6. Creating a multicomponent application with odo
odo allows you to create a multicomponent application, modify it, and link its components in an easy and automated way.
This example describes how to deploy a multicomponent application - a shooter game. The application consists of a front-end Node.js component and a back-end Java component.
Prerequisites
-
odois installed. - You have a running OpenShift Container Platform cluster. Developers can use CodeReady Containers (CRC) to deploy a local OpenShift Container Platform cluster quickly.
- Maven is installed.
2.6.1. Creating a project
Create a project to keep your source code, tests, and libraries organized in a separate single unit.
Procedure
Log in to an OpenShift Container Platform cluster:
odo login -u developer -p developer
$ odo login -u developer -p developerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a project:
odo project create myproject
$ odo project create myproject ✓ Project 'myproject' is ready for use ✓ New project created and now using project : myprojectCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.2. Deploying the back-end component
To create a Java component, import the Java builder image, download the Java application and push the source code to your cluster with odo.
Procedure
Import
openjdk18into the cluster:oc import-image openjdk18 \ --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift --confirm
$ oc import-image openjdk18 \ --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift --confirmCopy to Clipboard Copied! Toggle word wrap Toggle overflow Tag the image as
builderto make it accessible for odo:oc annotate istag/openjdk18:latest tags=builder
$ oc annotate istag/openjdk18:latest tags=builderCopy to Clipboard Copied! Toggle word wrap Toggle overflow Run
odo catalog list componentsto see the created image:odo catalog list components Odo Supported OpenShift Components: NAME PROJECT TAGS nodejs openshift 10,8,8-RHOAR,latest openjdk18 myproject latest
$ odo catalog list components Odo Supported OpenShift Components: NAME PROJECT TAGS nodejs openshift 10,8,8-RHOAR,latest openjdk18 myproject latestCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a directory for your components:
mkdir my_components $$ cd my_components
$ mkdir my_components $$ cd my_componentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Download the example back-end application:
git clone https://github.com/openshift-evangelists/Wild-West-Backend backend
$ git clone https://github.com/openshift-evangelists/Wild-West-Backend backendCopy to Clipboard Copied! Toggle word wrap Toggle overflow Change directory to the back-end source directory and check that you have the correct files in the directory:
cd backend ls
$ cd backend $ ls debug.sh pom.xml srcCopy to Clipboard Copied! Toggle word wrap Toggle overflow Build the back-end source files with Maven to create a JAR file:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a component configuration of Java component-type named
backend:odo create openjdk18 backend --binary target/wildwest-1.0.jar
$ odo create openjdk18 backend --binary target/wildwest-1.0.jar ✓ Validating component [1ms] Please use `odo push` command to create the component with source deployedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Now the configuration file
config.yamlis in the local directory of the back-end component that contains information about the component for deployment.Check the configuration settings of the back-end component in the
config.yamlfile using:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Push the component to the OpenShift Container Platform cluster.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Using
odo push, OpenShift Container Platform creates a container to host the back-end component, deploys the container into a Pod running on the OpenShift Container Platform cluster, and starts thebackendcomponent.Validate:
The status of the action in odo:
odo log -f 2019-09-30 20:14:19.738 INFO 444 --- [ main] c.o.wildwest.WildWestApplication : Starting WildWestApplication v1.0 onbackend-app-1-9tnhc with PID 444 (/deployments/wildwest-1.0.jar started by jboss in /deployments)
odo log -f 2019-09-30 20:14:19.738 INFO 444 --- [ main] c.o.wildwest.WildWestApplication : Starting WildWestApplication v1.0 onbackend-app-1-9tnhc with PID 444 (/deployments/wildwest-1.0.jar started by jboss in /deployments)Copy to Clipboard Copied! Toggle word wrap Toggle overflow The status of the back-end component:
odo list
$ odo list APP NAME TYPE SOURCE STATE app backend openjdk18 file://target/wildwest-1.0.jar PushedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.3. Deploying the front-end component
To create and deploy a front-end component, download the Node.js application and push the source code to your cluster with odo.
Procedure
Download the example front-end application:
git clone https://github.com/openshift/nodejs-ex
$ git clone https://github.com/openshift/nodejs-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow Change the current directory to the front-end directory:
cd <directory-name>
$ cd <directory-name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow List the contents of the directory to see that the front end is a Node.js application.
ls
$ ls assets bin index.html kwww-frontend.iml package.json package-lock.json playfield.png README.md server.jsCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe front-end component is written in an interpreted language (Node.js); it does not need to be built.
Create a component configuration of Node.js component-type named
frontend:odo create nodejs frontend
$ odo create nodejs frontend ✓ Validating component [5ms] Please use `odo push` command to create the component with source deployedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Push the component to a running container.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.4. Linking both components
Components running on the cluster need to be connected in order to interact. OpenShift Container Platform provides linking mechanisms to publish communication bindings from a program to its clients.
Procedure
List all the components that are running on the cluster:
odo list
$ odo list APP NAME TYPE SOURCE STATE app backend openjdk18 file://target/wildwest-1.0.jar Pushed app frontend nodejs file://./ PushedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Link the current front-end component to the backend:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The configuration information of the back-end component is added to the front-end component and the front-end component restarts.
2.6.5. Exposing components to the public
Procedure
Create an external URL for the application:
cd frontend odo url create frontend --port 8080
$ cd frontend $ odo url create frontend --port 8080 ✓ URL frontend created for component: frontend To create URL on the OpenShift cluster, use `odo push`Copy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the changes:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Open the URL in a browser to view the application.
If an application requires permissions to the active Service Account to access the OpenShift Container Platform namespace and delete active pods, the following error may occur when looking at odo log from the back-end component:
Message: Forbidden!Configured service account doesn’t have access. Service account may have been revoked
To resolve this error, add permissions for the Service Account role:
oc policy add-role-to-group view system:serviceaccounts -n <project> oc policy add-role-to-group edit system:serviceaccounts -n <project>
$ oc policy add-role-to-group view system:serviceaccounts -n <project>
$ oc policy add-role-to-group edit system:serviceaccounts -n <project>Do not do this on a production cluster.
2.6.6. Modifying the running application
Procedure
Change the local directory to the front-end directory:
cd ~/frontend
$ cd ~/frontendCopy to Clipboard Copied! Toggle word wrap Toggle overflow Monitor the changes on the file system using:
odo watch
$ odo watchCopy to Clipboard Copied! Toggle word wrap Toggle overflow Edit the
index.htmlfile to change the displayed name for the game.NoteA slight delay is possible before odo recognizes the change.
odo pushes the changes to the front-end component and prints its status to the terminal:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Refresh the application page in the web browser. The new name is now displayed.
2.6.7. Deleting an application
Deleting an application will delete all components associated with the application.
Procedure
List the applications in the current project:
odo app list
$ odo app list The project '<project_name>' has the following applications: NAME appCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the components associated with the applications. These components will be deleted with the application:
odo component list
$ odo component list APP NAME TYPE SOURCE STATE app nodejs-nodejs-ex-elyf nodejs file://./ PushedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the application:
odo app delete <application_name>
$ odo app delete <application_name> ? Are you sure you want to delete the application: <application_name> from project: <project_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Confirm the deletion with
Y. You can suppress the confirmation prompt using the-fflag.
2.7. Creating an application with a database
This example describes how to deploy and connect a database to a front-end application.
Prerequisites
-
odois installed. -
occlient is installed. - You have a running OpenShift Container Platform cluster. Developers can use CodeReady Containers (CRC) to deploy a local OpenShift Container Platform cluster quickly.
- Service Catalog is enabled.
2.7.1. Creating a project
Create a project to keep your source code, tests, and libraries organized in a separate single unit.
Procedure
Log in to an OpenShift Container Platform cluster:
odo login -u developer -p developer
$ odo login -u developer -p developerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a project:
odo project create myproject
$ odo project create myproject ✓ Project 'myproject' is ready for use ✓ New project created and now using project : myprojectCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.7.2. Deploying the front-end component
To create and deploy a front-end component, download the Node.js application and push the source code to your cluster with odo.
Procedure
Download the example front-end application:
git clone https://github.com/openshift/nodejs-ex
$ git clone https://github.com/openshift/nodejs-exCopy to Clipboard Copied! Toggle word wrap Toggle overflow Change the current directory to the front-end directory:
cd <directory-name>
$ cd <directory-name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow List the contents of the directory to see that the front end is a Node.js application.
ls
$ ls assets bin index.html kwww-frontend.iml package.json package-lock.json playfield.png README.md server.jsCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe front-end component is written in an interpreted language (Node.js); it does not need to be built.
Create a component configuration of Node.js component-type named
frontend:odo create nodejs frontend
$ odo create nodejs frontend ✓ Validating component [5ms] Please use `odo push` command to create the component with source deployedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a URL to access the frontend interface.
odo url create myurl
$ odo url create myurl ✓ URL myurl created for component: nodejs-nodejs-ex-pmdpCopy to Clipboard Copied! Toggle word wrap Toggle overflow Push the component to the OpenShift Container Platform cluster.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.7.3. Deploying a database in interactive mode
odo provides a command-line interactive mode which simplifies deployment.
Procedure
Run the interactive mode and answer the prompts:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Your password or username will be passed to the front-end application as environment variables.
2.7.4. Deploying a database manually
List the available services:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Choose the
mongodb-persistenttype of service and see the required parameters:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Pass the required parameters as flags and wait for the deployment of the database:
odo service create mongodb-persistent --plan default --wait -p DATABASE_SERVICE_NAME=mongodb -p MEMORY_LIMIT=512Mi -p MONGODB_DATABASE=sampledb -p VOLUME_CAPACITY=1Gi
$ odo service create mongodb-persistent --plan default --wait -p DATABASE_SERVICE_NAME=mongodb -p MEMORY_LIMIT=512Mi -p MONGODB_DATABASE=sampledb -p VOLUME_CAPACITY=1GiCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.7.5. Connecting the database to the front-end application
Link the database to the front-end service:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow See the environment variables of the application and the database in the Pod:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Open the URL in the browser and notice the database configuration in the bottom right:
odo url list
$ odo url listCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.7.6. Deleting an application
Deleting an application will delete all components associated with the application.
Procedure
List the applications in the current project:
odo app list
$ odo app list The project '<project_name>' has the following applications: NAME appCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the components associated with the applications. These components will be deleted with the application:
odo component list
$ odo component list APP NAME TYPE SOURCE STATE app nodejs-nodejs-ex-elyf nodejs file://./ PushedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the application:
odo app delete <application_name>
$ odo app delete <application_name> ? Are you sure you want to delete the application: <application_name> from project: <project_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Confirm the deletion with
Y. You can suppress the confirmation prompt using the-fflag.
2.8. Using sample applications
odo offers partial compatibility with any language or runtime listed within the OpenShift catalog of component types. For example:
For odo 1.0 Java and Node.js are the officialy supported component types. Run odo catalog list components to verify the officially supported component types.
In order to access the component over the web, create a URL using odo url create.
2.8.1. Examples from Git repositories
2.8.1.1. httpd
This example helps build and serve static content using httpd on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the Apache HTTP Server container image repository.
odo create httpd --git https://github.com/openshift/httpd-ex.git
$ odo create httpd --git https://github.com/openshift/httpd-ex.git2.8.1.2. java
This example helps build and run fat JAR Java applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the Java S2I Builder image.
odo create java --git https://github.com/spring-projects/spring-petclinic.git
$ odo create java --git https://github.com/spring-projects/spring-petclinic.git2.8.1.3. nodejs
Build and run Node.js applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the Node.js 8 container image.
odo create nodejs --git https://github.com/openshift/nodejs-ex.git
$ odo create nodejs --git https://github.com/openshift/nodejs-ex.git2.8.1.4. perl
This example helps build and run Perl applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the Perl 5.26 container image.
odo create perl --git https://github.com/openshift/dancer-ex.git
$ odo create perl --git https://github.com/openshift/dancer-ex.git2.8.1.5. php
This example helps build and run PHP applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the PHP 7.1 Docker image.
odo create php --git https://github.com/openshift/cakephp-ex.git
$ odo create php --git https://github.com/openshift/cakephp-ex.git2.8.1.6. python
This example helps build and run Python applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the Python 3.6 container image.
odo create python --git https://github.com/openshift/django-ex.git
$ odo create python --git https://github.com/openshift/django-ex.git2.8.1.7. ruby
This example helps build and run Ruby applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see Ruby 2.5 container image.
odo create ruby --git https://github.com/openshift/ruby-ex.git
$ odo create ruby --git https://github.com/openshift/ruby-ex.git2.8.1.8. wildfly
This example helps build and run WildFly applications on CentOS 7. For more information about using this builder image, including OpenShift Container Platform considerations, see the Wildfly - CentOS Docker images for OpenShift.
odo create wildfly --git https://github.com/openshift/openshift-jee-sample.git
$ odo create wildfly --git https://github.com/openshift/openshift-jee-sample.git2.8.2. Binary examples
2.8.2.1. java
Java can be used to deploy a binary artifact as follows:
git clone https://github.com/spring-projects/spring-petclinic.git cd spring-petclinic mvn package odo create java test3 --binary target/*.jar odo push
$ git clone https://github.com/spring-projects/spring-petclinic.git
$ cd spring-petclinic
$ mvn package
$ odo create java test3 --binary target/*.jar
$ odo push2.8.2.2. wildfly
WildFly can be used to deploy a binary application as follows:
2.9. Managing environment variables
odo stores component-specific configurations and environment variables in the config file. You can use the odo config command to set, unset, and list environment variables for components without the need to modify the config file.
2.9.1. Setting and unsetting environment variables
Procedure
To set an environment variable in a component:
odo config set --env <variable>=<value>
$ odo config set --env <variable>=<value>Copy to Clipboard Copied! Toggle word wrap Toggle overflow To unset an environment variable in a component:
odo config unset --env <variable>
$ odo config unset --env <variable>Copy to Clipboard Copied! Toggle word wrap Toggle overflow To list all environment variables in a component:
odo config view
$ odo config viewCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.10. Configuring the odo CLI
2.10.1. Using command completion
Currently command completion is only supported for bash, zsh, and fish shells.
odo provides a smart completion of command parameters based on user input. For this to work, odo needs to integrate with the executing shell.
Procedure
To install command completion automatically:
Run:
odo --complete
$ odo --completeCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
Press
ywhen prompted to install the completion hook.
-
To install the completion hook manually, add
complete -o nospace -C <full path to your odo binary> odoto your shell configuration file. After any modification to your shell configuration file, restart your shell. To disable completion:
Run:
odo --uncomplete
$ odo --uncompleteCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
Press
ywhen prompted to uninstall the completion hook.
Re-enable command completion if you either rename the odo executable or move it to a different directory.
2.10.2. Ignoring files or patterns
You can configure a list of files or patterns to ignore by modifying the .odoignore file in the root directory of your application. This applies to both odo push and odo watch.
If the .odoignore file does not exist, the .gitignore file is used instead for ignoring specific files and folders.
To ignore .git files, any files with the .js extension, and the folder tests, add the following to either the .odoignore or the .gitignore file:
.git *.js tests/
.git
*.js
tests/
The .odoignore file allows any glob expressions.
2.11. odo CLI reference
2.11.1. Basic odo CLI commands
2.11.1.1. app
Perform application operations related to your OpenShift Container Platform project.
Example using app
2.11.1.2. catalog
Perform catalog-related operations.
Example using catalog
2.11.1.3. component
Manage components of an application.
Example using component
Create a new component Create a local configuration and create all objects on the cluster
# Create a new component
odo component create
# Create a local configuration and create all objects on the cluster
odo component create --now2.11.1.4. config
Modify odo specific settings within the config file.
Example using config
| Application | Application is the name of application the component needs to be part of |
| CPU | The minimum and maximum CPU a component can consume |
| Ignore | Consider the .odoignore file for push and watch |
| Application | The name of application that the component needs to be part of |
| CPU | The minimum and maximum CPU a component can consume |
| Ignore |
Whether to consider the |
| MaxCPU | The maximum CPU a component can consume |
| MaxMemory | The maximum memory a component can consume |
| Memory | The minimum and maximum memory a component can consume |
| MinCPU | The minimum CPU a component can consume |
| MinMemory | The minimum memory a component is provided |
| Name | The name of the component |
| Ports | Ports to be opened in the component |
| Project | The name of the project that the component is part of |
| Ref | Git ref to use for creating component from git source |
| SourceLocation | The path indicates the location of binary file or git source |
| SourceType | Type of component source - git/binary/local |
| Storage | Storage of the component |
| Type | The type of component |
| Url | The URL to access the component |
2.11.1.5. create
Create a configuration describing a component to be deployed on OpenShift Container Platform. If a component name is not provided, it is autogenerated.
By default, builder images are used from the current namespace. To explicitly supply a namespace, use: odo create namespace/name:version. If a version is not specified, the version defaults to latest.
Use odo catalog list to see a full list of component types that can be deployed.
Example using create
2.11.1.6. delete
Delete an existing component.
Example using delete
Delete component named 'frontend'.
# Delete component named 'frontend'.
odo delete frontend
odo delete frontend --all2.11.1.7. describe
Describe the given component.
Example using describe
Describe nodejs component
# Describe nodejs component
odo describe nodejs2.11.1.8. link
Link a component to a service or component.
Example using link
Link adds the appropriate secret to the environment of the source component. The source component can then consume the entries of the secret as environment variables. If the source component is not provided, the current active component is assumed.
2.11.1.9. list
List all the components in the current application.
Example using list
List all components in the application
# List all components in the application
odo list2.11.1.10. log
Retrieve the log for the given component.
Example using log
Get the logs for the nodejs component
# Get the logs for the nodejs component
odo log nodejs2.11.1.11. login
Log in to the cluster.
Example using login
2.11.1.12. logout
Log out of the current OpenShift Container Platform session.
Example using logout
Log out
# Log out
odo logout2.11.1.13. preference
Modify odo specific configuration settings within the global preference file.
Example using preference
By default, the path to the global preference file is ~/.odo/preferece.yaml and it is stored in the environment variable GLOBALODOCONFIG. You can set up a custom path by setting the value of the environment variable to a new preference path, for example GLOBALODOCONFIG="new_path/preference.yaml"
| NamePrefix | The default prefix is the current directory name. Use this value to set a default name prefix. |
| Timeout | The timeout (in seconds) for OpenShift Container Platform server connection checks. |
| UpdateNotification | Controls whether an update notification is shown. |
2.11.1.14. project
Perform project operations.
Example using project
2.11.1.15. push
Push source code to a component.
Example using push
2.11.1.16. service
Perform service catalog operations.
Example using service
2.11.1.17. storage
Perform storage operations.
Example using storage
2.11.1.18. unlink
Unlink component or a service.
For this command to be successful, the service or component must have been linked prior to the invocation using odo link.
Example using unlink
2.11.1.19. update
Update the source code path of a component
Example using update
2.11.1.20. url
Expose a component to the outside world.
Example using url
The URLs that are generated using this command can be used to access the deployed components from outside the cluster.
2.11.1.21. utils
Utilities for terminal commands and modifying odo configurations.
Example using utils
Bash terminal PS1 support
# Bash terminal PS1 support
source <(odo utils terminal bash)
# Zsh terminal PS1 support
source <(odo utils terminal zsh)2.11.1.22. version
Print the client version information.
Example using version
Print the client version of odo
# Print the client version of odo
odo version2.11.1.23. watch
odo starts watching for changes and updates the component upon a change automatically.
Example using watch
Watch for changes in directory for current component
# Watch for changes in directory for current component
odo watch
# Watch for changes in directory for component called frontend
odo watch frontend2.12. odo 1.0 release notes
2.12.1. Notable features in odo 1.0
odo 1.0 offers a simple way to develop applications on OpenShift Container Platform. odo is completely client-based and requires no server within OpenShift Container Platform cluster.
odo 1.0 comes with:
- Simple syntax and design centered around concepts familiar to developers such as projects, applications and components.
- Compatibility with any language or runtime within the OpenShift catalog of component types.
- Capability to add custom component types using custom image builders.
- Official support for Java and Node.js component types.
- Service catalog which allows users to connect applications deployed on OpenShift Container Platform cluster to the Template Service Broker.
-
odo service create- an interactive mode which guides users through the process of creating applications. -
odo watch- a feature that automatically detects changes to local code and applies the changes to the component in real time.
2.12.2. Getting support
Documentation
If you have found an error or have suggestions for improving the documentation, file an issue in Bugzilla. Choose the OpenShift Container Platform product type and the Documentation component type.
Product
If you have found an error, encountered a bug or have suggestions for improving the functionality of odo, file an issue in Bugzilla. Choose the OpenShift Container Platform product type and the odo component type.
Provide as many details in the description of the issue as possible.
2.12.3. Technology Preview features in odo 1.0
Technology Preview features are not fully supported, may not be functionally complete, and are not suitable for deployment in production. Customers are encouraged to provide feedback and functionality suggestions for a Technology Preview feature before it becomes fully supported.
odo debugis a feature that allows users to attach a local debugger to a component running in the Pod on OpenShift Container Platform.Use
odo debug port-forwardto start the port forwarding.Use
odo config set DebugPort 9292to specify the remote port on which debugging agent should run.Use
odo debug port-forward --local-port 9292to specify the local port for port forwarding.
2.12.4. Known issues
- Bug 1760573 An active pointer is not pointing to a current active project.
-
Bug 1760574 A deleted namespace is being listed in the
odo project getcommand. -
Bug 1760575
odo app deleteremoves application components but not services. -
Bug 1760577
odo pushdoes not delete OpenShift objects when the component name is changed. -
Bug 1760580
catalog list componentsdoes not list out components of a specified namespace. -
Bug 1760583
odo config unsetdoes not unset an environment variable but says it did. -
Bug 1760585
odo delete --alldeletes the`$HOME/.odo` folder when run from$HOME. -
Bug 1760586
odo deletestarts an infinite loop after project is deleted and a component name is set. - Bug 1760587 odo reports an invalid flag when a non-existent command is used.
-
Bug 1760588
odo service createcrashes when run in Cygwin. -
Bug 1760589 Autocompletion does not work for
--contextinodo push. -
Bug 1760590 In Git BASH for Windows
odo login -u developerdoes not hide a typed password when requested. - Bug 1761440 It is not possible to create two services of the same type in one project.
-
Bug 1761442
component createfails with flag--contextand--binaryif the binary is located in a temporary folder. - Bug 1761443 Deleted files are not removed from a Java component.
Legal Notice
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman 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 Software Collections 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.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}