Table of Contents
Red Hat OpenShift CLI Tools
CLI tools Outline for Study
1. OpenShift Container Platform CLI tools overview
1.1. List of CLI tools
2. OpenShift CLI (oc)
2.1. Getting started with the OpenShift CLI
2.1.1. About the OpenShift CLI
2.1.2. Installing the OpenShift CLI
2.1.2.1. Installing the OpenShift CLI by downloading the binary
2.1.2.2. Installing the OpenShift CLI by using an RPM
2.1.3. Logging in to the OpenShift CLI
2.1.4. Using the OpenShift CLI
2.1.4.1. Creating a project 2.1.4.2. Creating a new app
2.1.4.3. Viewing pods
2.1.4.4. Viewing pod logs
2.1.4.5. Viewing the current project
2.1.4.6. Viewing the status for the current project
2.1.4.7. Listing supported API resources
2.1.5. Getting help
2.1.6. Logging out of the OpenShift CLI
2.2. Configuring the OpenShift CLI
2.2.1. Enabling tab completion
2.3. Extending the OpenShift CLI with plug-ins
2.3.1. Writing CLI plug-ins
2.3.2. Installing and using CLI plug-ins
2.4. OpenShift CLI developer command reference
2.4.1. OpenShift CLI (oc) developer commands
2.4.1.1. oc annotate
2.4.1.2. oc api-resources
2.4.1.3. oc api-versions
2.4.1.4. oc apply
2.4.1.5. oc apply edit-last-applied
2.4.1.6. oc apply set-last-applied
2.4.1.7. oc apply view-last-applied
2.4.1.8. oc attach
2.4.1.9. oc auth can-i
2.4.1.10. oc auth reconcile
2.4.1.11. oc autoscale
2.4.1.12. oc cancel-build
2.4.1.13. oc cluster-info
2.4.1.14. oc cluster-info dump
2.4.1.15. oc completion
2.4.1.16. oc config current-context
2.4.1.17. oc config delete-cluster
2.4.1.18. oc config delete-context
2.4.1.19. oc config delete-user
2.4.1.20. oc config get-clusters
2.4.1.21. oc config get-contexts
2.4.1.22. oc config get-users
2.4.1.23. oc config rename-context
2.4.1.24. oc config set
2.4.1.25. oc config set-cluster
2.4.1.26. oc config set-context
2.4.1.27. oc config set-credentials
2.4.1.28. oc config unset
2.4.1.29. oc config use-context
2.4.1.30. oc config view
2.4.1.31. oc cp
2.4.1.32. oc create
2.4.1.33. oc create build
2.4.1.34. oc create clusterresourcequota
2.4.1.35. oc create clusterrole
2.4.1.36. oc create clusterrolebinding
2.4.1.37. oc create configmap
2.4.1.38. oc create cronjob
2.4.1.39. oc create deployment
2.4.1.40. oc create deploymentconfig
2.4.1.41. oc create identity
2.4.1.42. oc create imagestream
2.4.1.43. oc create imagestreamtag
2.4.1.44. oc create ingress
2.4.1.45. oc create job
2.4.1.46. oc create namespace
2.4.1.47. oc create poddisruptionbudget
2.4.1.48. oc create priorityclass
2.4.1.49. oc create quota
2.4.1.50. oc create role
2.4.1.51. oc create rolebinding
2.4.1.52. oc create route edge
2.4.1.53. oc create route passthrough
2.4.1.54. oc create route reencrypt
2.4.1.55. oc create secret docker-registry
2.4.1.56. oc create secret generic
2.4.1.57. oc create secret tls
2.4.1.58. oc create service clusterip
2.4.1.59. oc create service externalname
2.4.1.60. oc create service loadbalancer
2.4.1.61. oc create service nodeport
2.4.1.62. oc create serviceaccount
2.4.1.63. oc create user
2.4.1.64. oc create useridentitymapping
2.4.1.65. oc debug
2.4.1.66. oc delete
2.4.1.67. oc describe
2.4.1.68. oc diff
2.4.1.69. oc edit
2.4.1.70. oc ex dockergc
2.4.1.71. oc exec
2.4.1.72. oc explain
2.4.1.73. oc expose
2.4.1.74. oc extract
2.4.1.75. oc get
2.4.1.76. oc idle
2.4.1.77. oc image append
2.4.1.78. oc image extract
2.4.1.79. oc image info
2.4.1.80. oc image mirror
2.4.1.81. oc import-image
2.4.1.82. oc kustomize
2.4.1.83. oc label
2.4.1.84. oc login
2.4.1.85. oc logout
2.4.1.86. oc logs
2.4.1.87. oc new-app
2.4.1.88. oc new-build
2.4.1.89. oc new-project
2.4.1.90. oc observe
2.4.1.91. oc patch
2.4.1.92. oc policy add-role-to-user
2.4.1.93. oc policy scc-review
2.4.1.94. oc policy scc-subject-review
2.4.1.95. oc port-forward
2.4.1.96. oc process
2.4.1.97. oc project
2.4.1.98. oc projects
2.4.1.99. oc proxy
2.4.1.100. oc registry info
2.4.1.101. oc registry login
2.4.1.102. oc replace
2.4.1.103. oc rollback
2.4.1.104. oc rollout cancel
2.4.1.105. oc rollout history
2.4.1.106. oc rollout latest
2.4.1.107. oc rollout pause
2.4.1.108. oc rollout restart
2.4.1.109. oc rollout resume
2.4.1.110. oc rollout retry
2.4.1.111. oc rollout status
2.4.1.112. oc rollout undo
2.4.1.113. oc rsh
2.4.1.114. oc rsync
2.4.1.115. oc run
2.4.1.116. oc scale
2.4.1.117. oc secrets link
2.4.1.118. oc secrets unlink
2.4.1.119. oc serviceaccounts create-kubeconfig
2.4.1.120. oc serviceaccounts get-token
2.4.1.121. oc serviceaccounts new-token
2.4.1.122. oc set build-hook
2.4.1.123. oc set build-secret
2.4.1.124. oc set data
2.4.1.125. oc set deployment-hook
2.4.1.126. oc set env
2.4.1.127. oc set image
2.4.1.128. oc set image-lookup
2.4.1.129. oc set probe
2.4.1.130. oc set resources
2.4.1.131. oc set route-backends
2.4.1.132. oc set selector
2.4.1.133. oc set serviceaccount
2.4.1.134. oc set subject
2.4.1.135. oc set triggers
2.4.1.136. oc set volumes
2.4.1.137. oc start-build
2.4.1.138. oc status
2.4.1.139. oc tag
2.4.1.140. oc version
2.4.1.141. oc wait
2.4.1.142. oc whoami
2.4.2. Additional resources
2.5. OpenShift CLI administrator command reference
2.5.1. OpenShift CLI (oc) administrator commands
2.5.1.1. oc adm build-chain
2.5.1.2. oc adm catalog mirror
2.5.1.3. oc adm certificate approve
2.5.1.4. oc adm certificate deny
2.5.1.5. oc adm completion
2.5.1.6. oc adm config current-context
2.5.1.7. oc adm config delete-cluster
2.5.1.8. oc adm config delete-context
2.5.1.9. oc adm config delete-user
2.5.1.10. oc adm config get-clusters
2.5.1.11. oc adm config get-contexts
2.5.1.12. oc adm config get-users
2.5.1.13. oc adm config rename-context
2.5.1.14. oc adm config set
2.5.1.15. oc adm config set-cluster
2.5.1.16. oc adm config set-context
2.5.1.17. oc adm config set-credentials
2.5.1.18. oc adm config unset
2.5.1.19. oc adm config use-context
2.5.1.20. oc adm config view
2.5.1.21. oc adm cordon
2.5.1.22. oc adm create-bootstrap-project-template
2.5.1.23. oc adm create-error-template
2.5.1.24. oc adm create-login-template
2.5.1.25. oc adm create-provider-selection-template
2.5.1.26. oc adm drain
2.5.1.27. oc adm groups add-users
2.5.1.28. oc adm groups new
2.5.1.29. oc adm groups prune
2.5.1.30. oc adm groups remove-users
2.5.1.31. oc adm groups sync
2.5.1.32. oc adm inspect
2.5.1.33. oc adm migrate template-instances
2.5.1.34. oc adm must-gather
2.5.1.35. oc adm new-project
2.5.1.36. oc adm node-logs
2.5.1.37. oc adm pod-network isolate-projects
2.5.1.38. oc adm pod-network join-projects
2.5.1.39. oc adm pod-network make-projects-global
2.5.1.40. oc adm policy add-role-to-user
2.5.1.41. oc adm policy add-scc-to-group
2.5.1.42. oc adm policy add-scc-to-user
2.5.1.43. oc adm policy scc-review
2.5.1.44. oc adm policy scc-subject-review
2.5.1.45. oc adm prune builds
2.5.1.46. oc adm prune deployments
2.5.1.47. oc adm prune groups
2.5.1.48. oc adm prune images
2.5.1.49. oc adm release extract
2.5.1.50. oc adm release info
2.5.1.51. oc adm release mirror
2.5.1.52. oc adm release new
2.5.1.53. oc adm taint
2.5.1.54. oc adm top images
2.5.1.55. oc adm top imagestreams
2.5.1.56. oc adm top node
2.5.1.57. oc adm top pod
2.5.1.58. oc adm uncordon
2.5.1.59. oc adm verify-image-signature
2.5.2. Additional resources
2.6. Usage of oc and kubectl commands
2.6.1. The oc binary
2.6.2. The kubectl binary
3. Developer CLI (odo)
3.1. {odo-title} release notes
3.1.1. Notable changes and improvements in odo
3.1.2. Getting support
3.1.3. Known issues
3.2. Understanding odo
3.2.1. Key features
3.2.2. Core concepts
3.2.2.1. Officially supported languages and corresponding container images
3.2.2.1.1. Listing available container images
3.2.2.2. Telemetry in odo
3.3. Installing odo
3.3.1. Installing odo on Linux
3.3.1.1. Binary installation
3.3.1.2. Tarball installation
3.3.1.3. Installing with yum on Red Hat Enterprise Linux (RHEL)
3.3.2. Installing odo on Linux on IBM Power
3.3.2.1. Binary installation
3.3.2.2. Tarball installation
3.3.3. Installing odo on Linux on IBM Z and LinuxONE
3.3.3.1. Binary installation
3.3.3.2. Tarball installation
3.3.4. Installing odo on Windows
3.3.4.1. Binary installation
3.3.5. Installing odo on macOS
3.3.5.1. Binary installation
3.3.5.2. Tarball installation
3.3.6. Installing odo on VS Code
3.4. Creating and deploying applications with odo
3.4.1. Working with projects
3.4.1.1. Creating a project
3.4.2. Creating a single-component application with odo
3.4.2.1. Creating a project
3.4.2.2. Creating a Node.js application with odo
3.4.2.3. Modifying your application code
3.4.2.4. Adding storage to the application components
3.4.2.5. Adding a custom builder to specify a build image
3.4.2.6. Connecting your application to multiple services using OpenShift Service Catalog
3.4.2.7. Deleting an application
3.4.3. Creating a multicomponent application with odo
3.4.3.1. Creating a project
3.4.3.2. Deploying the back-end component
3.4.3.3. Deploying the front-end component
3.4.3.4. Linking both components
3.4.3.5. Exposing components to the public
3.4.3.6. Modifying the running application
3.4.3.7. Deleting an application
3.4.4. Creating an application with a database
3.4.4.1. Creating a project
3.4.4.2. Deploying the front-end component
3.4.4.3. Deploying a database in interactive mode
3.4.4.4. Deploying a database manually
3.4.4.5. Connecting the database to the front-end application
3.4.5. Creating a Java application with a database
3.4.5.1. Creating a project
3.4.5.2. Creating a Java MicroServices JPA application
3.4.5.3. Creating a database with odo
3.4.5.4. Connecting a Java application to a database
3.4.6. Using devfiles in odo
3.4.6.1. About the devfile in odo
3.4.6.2. Creating a Java application by using a devfile
3.4.6.2.1. Creating a project
3.4.6.2.2. Listing available devfile components
3.4.6.2.3. Deploying a Java application using a devfile
3.4.6.3. Converting an S2I component into a devfile component
3.4.7. Working with storage
3.4.7.1. Adding storage to the application components
3.4.7.2. Adding storage to a specific container
3.4.7.3. Switching between ephemeral and persistent storage
3.4.8. Deleting applications
3.4.8.1. Deleting an application
3.4.9. Debugging applications in odo
3.4.9.1. Debugging an application
3.4.9.2. Configuring debugging parameters
3.4.10. Sample applications
3.4.10.1. Examples from Git repositories
3.4.10.1.1. httpd
3.4.10.1.2. java
3.4.10.1.3. nodejs
3.4.10.1.4. perl
3.4.10.1.5. php
3.4.10.1.6. python
3.4.10.1.7. ruby
3.4.10.2. Binary examples
3.4.10.2.1. java
3.5. Using odo in a restricted environment
3.5.1. About odo in a restricted environment
3.5.2. Pushing the odo init image to the restricted cluster registry
3.5.2.1. Prerequisites
3.5.2.2. Pushing the odo init image to a mirror registry
3.5.2.2.1. Pushing the init image to a mirror registry on Linux
3.5.2.2.2. Pushing the init image to a mirror registry on MacOS
3.5.2.2.3. Pushing the init image to a mirror registry on Windows
3.5.2.3. Pushing the odo init image to an internal registry directly
3.5.2.3.1. Pushing the init image directly on Linux
3.5.2.3.2. Pushing the init image directly on MacOS
3.5.2.3.3. Pushing the init image directly on Windows
3.5.3. Creating and deploying a component to the disconnected cluster
3.5.3.1. Prerequisites
3.5.3.2. Mirroring a supported builder image
3.5.3.3. Overwriting the mirror registry
3.5.3.4. Creating a Node.js application with odo
3.5.4. Creating and deploying devfile components to the disconnected cluster
3.5.4.1. Creating a NodeJS application by using a devfile in a disconnected cluster
3.5.4.2. Creating a Java application by using a devfile in a disconnected cluster
3.6. Creating instances of services managed by Operators
3.6.1. Prerequisites
3.6.2. Creating a project
3.6.3. Listing available services from the Operators installed on the cluster
3.6.4. Creating a service from an Operator
3.6.5. Creating services from YAML files
3.7. Managing environment variables
3.7.1. Setting and unsetting environment variables
3.8. Configuring the odo CLI
3.8.1. Using command completion
3.8.2. Ignoring files or patterns
3.9. odo CLI reference
3.9.1. Basic odo CLI commands
3.9.1.1. app
3.9.1.2. catalog
3.9.1.3. component
3.9.1.4. config
3.9.1.5. create
3.9.1.6. debug
3.9.1.7. delete
3.9.1.8. describe
3.9.1.9. link
3.9.1.10. list
3.9.1.11. log
3.9.1.12. login
3.9.1.13. logout
3.9.1.14. preference
3.9.1.15. project
3.9.1.16. push
3.9.1.17. registry
3.9.1.18. service
3.9.1.19. storage
3.9.1.20. unlink
3.9.1.21. update
3.9.1.22. url
3.9.1.23. utils
3.9.1.24. version
3.9.1.25. watch
3.10. odo architecture
3.10.1. Developer setup
3.10.2. OpenShift source-to-image
3.10.3. OpenShift cluster objects
3.10.3.1. Init Containers
3.10.3.1.1. copy-supervisord
3.10.3.1.2. copy-files-to-volume
3.10.3.2. Application container
3.10.3.3. Persistent volumes and persistent volume claims
3.10.3.4. emptyDir volume
3.10.3.5. Service
3.10.4. odo push workflow
4. Knative CLI (kn) for use with OpenShift Serverless
4.1. Key features
4.2. Installing the Knative CLI
5. Pipelines CLI (tkn)
5.1. Installing tkn
5.1.1. Installing Red Hat OpenShift Pipelines CLI (tkn) on Linux
5.1.2. Installing Red Hat OpenShift Pipelines CLI (tkn) on Linux using an RPM
5.1.3. Installing Red Hat OpenShift Pipelines CLI (tkn) on Windows
5.1.4. Installing Red Hat OpenShift Pipelines CLI (tkn) on macOS
5.2. Configuring the OpenShift Pipelines tkn CLI
5.2.1. Enabling tab completion
5.3. OpenShift Pipelines tkn reference
5.3.1. Basic syntax
5.3.2. Global options
5.3.3. Utility commands
5.3.3.1. tkn
5.3.3.2. completion [shell]
5.3.3.3. version
5.3.4. Pipelines management commands
5.3.4.1. pipeline
5.3.4.2. pipeline delete
5.3.4.3. pipeline describe
5.3.4.4. pipeline list
5.3.4.5. pipeline logs
5.3.4.6. pipeline start
5.3.5. Pipeline run commands
5.3.5.1. pipelinerun
5.3.5.2. pipelinerun cancel
5.3.5.3. pipelinerun delete
5.3.5.4. pipelinerun describe
5.3.5.5. pipelinerun list
5.3.5.6. pipelinerun logs
5.3.6. Task management commands
5.3.6.1. task
5.3.6.2. task delete
5.3.6.3. task describe
5.3.6.4. task list
5.3.6.5. task logs
5.3.6.6. task start
5.3.7. Task run commands
5.3.7.1. taskrun
5.3.7.2. taskrun cancel
5.3.7.3. taskrun delete
5.3.7.4. taskrun describe
5.3.7.5. taskrun list
5.3.7.6. taskrun logs
5.3.8. Condition management commands
5.3.8.1. condition
5.3.8.2. condition delete
5.3.8.3. condition describe
5.3.8.4. condition list
5.3.9. Pipeline Resource management commands
5.3.9.1. resource
5.3.9.2. resource create
5.3.9.3. resource delete
5.3.9.4. resource describe
5.3.9.5. resource list
5.3.10. ClusterTask management commands
5.3.10.1. clustertask
5.3.10.2. clustertask delete
5.3.10.3. clustertask describe
5.3.10.4. clustertask list
5.3.10.5. clustertask start
5.3.11. Trigger management commands
5.3.11.1. eventlistener
5.3.11.2. eventlistener delete
5.3.11.3. eventlistener describe
5.3.11.4. eventlistener list
5.3.11.5. eventlistener logs
5.3.11.6. triggerbinding
5.3.11.7. triggerbinding delete
5.3.11.8. triggerbinding describe
5.3.11.9. triggerbinding list
5.3.11.10. triggertemplate
5.3.11.11. triggertemplate delete
5.3.11.12. triggertemplate describe
5.3.11.13. triggertemplate list
5.3.11.14. clustertriggerbinding
5.3.11.15. clustertriggerbinding delete
5.3.11.16. clustertriggerbinding describe
5.3.11.17. clustertriggerbinding list
5.3.12. Hub interaction commands
5.3.12.1. hub
5.3.12.2. hub downgrade
5.3.12.3. hub get
5.3.12.4. hub info
5.3.12.5. hub install
5.3.12.6. hub reinstall
5.3.12.7. hub search
5.3.12.8. hub upgrade
6. opm CLI
6.1. Installing the opm CLI
6.1.1. About the opm CLI
6.1.2. Installing the opm CLI
6.1.3. Additional resources
6.2. opm CLI reference
6.2.1. index
6.2.1.1. add
6.2.1.2. export
6.2.1.3. prune
6.2.1.4. prune-stranded
6.2.1.5. rm
6.2.2. init
6.2.3. render
6.2.4. validate
6.2.5. serve
7. Operator SDK
7.1. Installing the Operator SDK CLI
7.1.1. Installing the Operator SDK CLI
7.2. Operator SDK CLI reference
7.2.1. bundle
7.2.1.1. validate
7.2.2. cleanup
7.2.3. completion
7.2.4. create
7.2.4.1. api
7.2.5. generate
7.2.5.1. bundle
7.2.5.2. kustomize
7.2.5.2.1. manifests
7.2.6. init
7.2.7. run
7.2.7.1. bundle
7.2.7.2. bundle-upgrade
7.2.8. scorecard