Jump To Close Expand all Collapse all Table of contents CLI tools 1. OpenShift CLI (oc) Expand section "1. OpenShift CLI (oc)" Collapse section "1. OpenShift CLI (oc)" 1.1. Getting started with the CLI Expand section "1.1. Getting started with the CLI" Collapse section "1.1. Getting started with the CLI" 1.1.1. About the CLI 1.1.2. Installing the CLI Expand section "1.1.2. Installing the CLI" Collapse section "1.1.2. Installing the CLI" 1.1.2.1. Installing the CLI by downloading the binary Expand section "1.1.2.1. Installing the CLI by downloading the binary" Collapse section "1.1.2.1. Installing the CLI by downloading the binary" 1.1.2.1.1. Installing the CLI on Linux 1.1.2.1.2. Installing the CLI on Windows 1.1.2.1.3. Installing the CLI on macOS 1.1.2.2. Installing the CLI by using an RPM 1.1.3. Logging in to the CLI 1.1.4. Using the CLI Expand section "1.1.4. Using the CLI" Collapse section "1.1.4. Using the CLI" 1.1.4.1. Creating a project 1.1.4.2. Creating a new app 1.1.4.3. Viewing pods 1.1.4.4. Viewing pod logs 1.1.4.5. Viewing the current project 1.1.4.6. Viewing the status for the current project 1.1.4.7. Listing supported API resources 1.1.5. Getting help 1.1.6. Logging out of the CLI 1.2. Configuring the CLI Expand section "1.2. Configuring the CLI" Collapse section "1.2. Configuring the CLI" 1.2.1. Enabling tab completion 1.3. Extending the CLI with plug-ins Expand section "1.3. Extending the CLI with plug-ins" Collapse section "1.3. Extending the CLI with plug-ins" 1.3.1. Writing CLI plug-ins 1.3.2. Installing and using CLI plug-ins 1.4. Developer CLI commands Expand section "1.4. Developer CLI commands" Collapse section "1.4. Developer CLI commands" 1.4.1. Basic CLI commands Expand section "1.4.1. Basic CLI commands" Collapse section "1.4.1. Basic CLI commands" 1.4.1.1. explain 1.4.1.2. login 1.4.1.3. new-app 1.4.1.4. new-project 1.4.1.5. project 1.4.1.6. projects 1.4.1.7. status 1.4.2. Build and Deploy CLI commands Expand section "1.4.2. Build and Deploy CLI commands" Collapse section "1.4.2. Build and Deploy CLI commands" 1.4.2.1. cancel-build 1.4.2.2. import-image 1.4.2.3. new-build 1.4.2.4. rollback 1.4.2.5. rollout 1.4.2.6. start-build 1.4.2.7. tag 1.4.3. Application management CLI commands Expand section "1.4.3. Application management CLI commands" Collapse section "1.4.3. Application management CLI commands" 1.4.3.1. annotate 1.4.3.2. apply 1.4.3.3. autoscale 1.4.3.4. create 1.4.3.5. delete 1.4.3.6. describe 1.4.3.7. edit 1.4.3.8. expose 1.4.3.9. get 1.4.3.10. label 1.4.3.11. scale 1.4.3.12. secrets 1.4.3.13. serviceaccounts 1.4.3.14. set 1.4.4. Troubleshooting and debugging CLI commands Expand section "1.4.4. Troubleshooting and debugging CLI commands" Collapse section "1.4.4. Troubleshooting and debugging CLI commands" 1.4.4.1. attach 1.4.4.2. cp 1.4.4.3. debug 1.4.4.4. exec 1.4.4.5. logs 1.4.4.6. port-forward 1.4.4.7. proxy 1.4.4.8. rsh 1.4.4.9. rsync 1.4.4.10. run 1.4.4.11. wait 1.4.5. Advanced developer CLI commands Expand section "1.4.5. Advanced developer CLI commands" Collapse section "1.4.5. Advanced developer CLI commands" 1.4.5.1. api-resources 1.4.5.2. api-versions 1.4.5.3. auth 1.4.5.4. cluster-info 1.4.5.5. convert 1.4.5.6. extract 1.4.5.7. idle 1.4.5.8. image 1.4.5.9. observe 1.4.5.10. patch 1.4.5.11. policy 1.4.5.12. process 1.4.5.13. registry 1.4.5.14. replace 1.4.6. Settings CLI commands Expand section "1.4.6. Settings CLI commands" Collapse section "1.4.6. Settings CLI commands" 1.4.6.1. completion 1.4.6.2. config 1.4.6.3. logout 1.4.6.4. whoami 1.4.7. Other developer CLI commands Expand section "1.4.7. Other developer CLI commands" Collapse section "1.4.7. Other developer CLI commands" 1.4.7.1. help 1.4.7.2. plugin 1.4.7.3. version 1.5. Administrator CLI commands Expand section "1.5. Administrator CLI commands" Collapse section "1.5. Administrator CLI commands" 1.5.1. Cluster management CLI commands Expand section "1.5.1. Cluster management CLI commands" Collapse section "1.5.1. Cluster management CLI commands" 1.5.1.1. inspect 1.5.1.2. must-gather 1.5.1.3. top 1.5.2. Node management CLI commands Expand section "1.5.2. Node management CLI commands" Collapse section "1.5.2. Node management CLI commands" 1.5.2.1. cordon 1.5.2.2. drain 1.5.2.3. node-logs 1.5.2.4. taint 1.5.2.5. uncordon 1.5.3. Security and policy CLI commands Expand section "1.5.3. Security and policy CLI commands" Collapse section "1.5.3. Security and policy CLI commands" 1.5.3.1. certificate 1.5.3.2. groups 1.5.3.3. new-project 1.5.3.4. pod-network 1.5.3.5. policy 1.5.4. Maintenance CLI commands Expand section "1.5.4. Maintenance CLI commands" Collapse section "1.5.4. Maintenance CLI commands" 1.5.4.1. migrate 1.5.4.2. prune 1.5.5. Configuration CLI commands Expand section "1.5.5. Configuration CLI commands" Collapse section "1.5.5. Configuration CLI commands" 1.5.5.1. create-bootstrap-project-template 1.5.5.2. create-error-template 1.5.5.3. create-kubeconfig 1.5.5.4. create-login-template 1.5.5.5. create-provider-selection-template 1.5.6. Other Administrator CLI commands Expand section "1.5.6. Other Administrator CLI commands" Collapse section "1.5.6. Other Administrator CLI commands" 1.5.6.1. build-chain 1.5.6.2. completion 1.5.6.3. config 1.5.6.4. release 1.5.6.5. verify-image-signature 1.6. Usage of oc and kubectl commands Expand section "1.6. Usage of oc and kubectl commands" Collapse section "1.6. Usage of oc and kubectl commands" 1.6.1. The oc binary 1.6.2. The kubectl binary 2. Developer CLI (odo) Expand section "2. Developer CLI (odo)" Collapse section "2. Developer CLI (odo)" 2.1. Understanding odo Expand section "2.1. Understanding odo" Collapse section "2.1. Understanding odo" 2.1.1. Key features 2.1.2. Core concepts Expand section "2.1.2. Core concepts" Collapse section "2.1.2. Core concepts" 2.1.2.1. Officially supported languages and corresponding container images Expand section "2.1.2.1. Officially supported languages and corresponding container images" Collapse section "2.1.2.1. Officially supported languages and corresponding container images" 2.1.2.1.1. Listing available container images 2.2. odo architecture Expand section "2.2. odo architecture" Collapse section "2.2. odo architecture" 2.2.1. Developer setup 2.2.2. OpenShift source-to-image 2.2.3. OpenShift cluster objects Expand section "2.2.3. OpenShift cluster objects" Collapse section "2.2.3. OpenShift cluster objects" 2.2.3.1. Init Containers Expand section "2.2.3.1. Init Containers" Collapse section "2.2.3.1. Init Containers" 2.2.3.1.1. copy-supervisord 2.2.3.1.2. copy-files-to-volume 2.2.3.2. Application container 2.2.3.3. Persistent volumes and persistent volume claims 2.2.3.4. emptyDir volume 2.2.3.5. Service 2.2.4. odo push workflow 2.3. Installing odo Expand section "2.3. Installing odo" Collapse section "2.3. Installing odo" 2.3.1. Installing odo on Linux Expand section "2.3.1. Installing odo on Linux" Collapse section "2.3.1. Installing odo on Linux" 2.3.1.1. Binary installation 2.3.1.2. Tarball installation 2.3.2. Installing odo on Linux on IBM Power Expand section "2.3.2. Installing odo on Linux on IBM Power" Collapse section "2.3.2. Installing odo on Linux on IBM Power" 2.3.2.1. Binary installation 2.3.2.2. Tarball installation 2.3.3. Installing odo on Linux on IBM Z and LinuxONE Expand section "2.3.3. Installing odo on Linux on IBM Z and LinuxONE" Collapse section "2.3.3. Installing odo on Linux on IBM Z and LinuxONE" 2.3.3.1. Binary installation 2.3.3.2. Tarball installation 2.3.4. Installing odo on Windows Expand section "2.3.4. Installing odo on Windows" Collapse section "2.3.4. Installing odo on Windows" 2.3.4.1. Binary installation 2.3.5. Installing odo on macOS Expand section "2.3.5. Installing odo on macOS" Collapse section "2.3.5. Installing odo on macOS" 2.3.5.1. Binary installation 2.3.5.2. Tarball installation 2.4. Using odo in a restricted environment Expand section "2.4. Using odo in a restricted environment" Collapse section "2.4. Using odo in a restricted environment" 2.4.1. About odo in a restricted environment 2.4.2. Pushing the odo init image to the restricted cluster registry Expand section "2.4.2. Pushing the odo init image to the restricted cluster registry" Collapse section "2.4.2. Pushing the odo init image to the restricted cluster registry" 2.4.2.1. Prerequisites 2.4.2.2. Pushing the odo init image to a mirror registry Expand section "2.4.2.2. Pushing the odo init image to a mirror registry" Collapse section "2.4.2.2. Pushing the odo init image to a mirror registry" 2.4.2.2.1. Pushing the init image to a mirror registry on Linux 2.4.2.2.2. Pushing the init image to a mirror registry on MacOS 2.4.2.2.3. Pushing the init image to a mirror registry on Windows 2.4.2.3. Pushing the odo init image to an internal registry directly Expand section "2.4.2.3. Pushing the odo init image to an internal registry directly" Collapse section "2.4.2.3. Pushing the odo init image to an internal registry directly" 2.4.2.3.1. Pushing the init image directly on Linux 2.4.2.3.2. Pushing the init image directly on MacOS 2.4.2.3.3. Pushing the init image directly on Windows 2.4.3. Creating and deploying a component to the disconnected cluster Expand section "2.4.3. Creating and deploying a component to the disconnected cluster" Collapse section "2.4.3. Creating and deploying a component to the disconnected cluster" 2.4.3.1. Prerequisites 2.4.3.2. Mirroring a supported builder image 2.4.3.3. Overwriting the mirror registry 2.4.3.4. Creating a Node.js application with odo 2.5. Creating a single-component application with odo Expand section "2.5. Creating a single-component application with odo" Collapse section "2.5. Creating a single-component application with odo" 2.5.1. Prerequisites 2.5.2. Creating a project 2.5.3. Creating a Node.js application with odo 2.5.4. Modifying your application code 2.5.5. Adding storage to the application components 2.5.6. Adding a custom builder to specify a build image 2.5.7. Connecting your application to multiple services using OpenShift Service Catalog 2.5.8. Deleting an application 2.6. Creating a multicomponent application with odo Expand section "2.6. Creating a multicomponent application with odo" Collapse section "2.6. Creating a multicomponent application with odo" 2.6.1. Prerequisites 2.6.2. Creating a project 2.6.3. Deploying the back-end component 2.6.4. Deploying the front-end component 2.6.5. Linking both components 2.6.6. Exposing components to the public 2.6.7. Modifying the running application 2.6.8. Deleting an application 2.7. Creating an application with a database Expand section "2.7. Creating an application with a database" Collapse section "2.7. Creating an application with a database" 2.7.1. Prerequisites 2.7.2. Creating a project 2.7.3. Deploying the front-end component 2.7.4. Deploying a database in interactive mode 2.7.5. Deploying a database manually 2.7.6. Connecting the database to the front-end application 2.7.7. Deleting an application 2.8. Using devfiles in odo Expand section "2.8. Using devfiles in odo" Collapse section "2.8. Using devfiles in odo" 2.8.1. About the devfile in odo 2.8.2. Creating a Java application by using a devfile 2.8.3. Prerequisites Expand section "2.8.3. Prerequisites" Collapse section "2.8.3. Prerequisites" 2.8.3.1. Creating a project 2.8.3.2. Listing available devfile components 2.8.3.3. Deploying a Java application using a devfile 2.8.4. Converting an S2I component into a devfile component 2.9. Using sample applications Expand section "2.9. Using sample applications" Collapse section "2.9. Using sample applications" 2.9.1. Examples from Git repositories Expand section "2.9.1. Examples from Git repositories" Collapse section "2.9.1. Examples from Git repositories" 2.9.1.1. httpd 2.9.1.2. java 2.9.1.3. nodejs 2.9.1.4. perl 2.9.1.5. php 2.9.1.6. python 2.9.1.7. ruby 2.9.1.8. wildfly 2.9.2. Binary examples Expand section "2.9.2. Binary examples" Collapse section "2.9.2. Binary examples" 2.9.2.1. java 2.9.2.2. wildfly 2.10. Creating instances of services managed by Operators Expand section "2.10. Creating instances of services managed by Operators" Collapse section "2.10. Creating instances of services managed by Operators" 2.10.1. Prerequisites 2.10.2. Creating a project 2.10.3. Listing available services from the Operators installed on the cluster 2.10.4. Creating a service from an Operator 2.10.5. Creating services from YAML files 2.11. Debugging applications in odo Expand section "2.11. Debugging applications in odo" Collapse section "2.11. Debugging applications in odo" 2.11.1. Debugging an application 2.11.2. Configuring debugging parameters 2.12. Managing environment variables Expand section "2.12. Managing environment variables" Collapse section "2.12. Managing environment variables" 2.12.1. Setting and unsetting environment variables 2.13. Configuring the odo CLI Expand section "2.13. Configuring the odo CLI" Collapse section "2.13. Configuring the odo CLI" 2.13.1. Using command completion 2.13.2. Ignoring files or patterns 2.14. odo CLI reference Expand section "2.14. odo CLI reference" Collapse section "2.14. odo CLI reference" 2.14.1. Basic odo CLI commands Expand section "2.14.1. Basic odo CLI commands" Collapse section "2.14.1. Basic odo CLI commands" 2.14.1.1. app 2.14.1.2. catalog 2.14.1.3. component 2.14.1.4. config 2.14.1.5. create 2.14.1.6. debug 2.14.1.7. delete 2.14.1.8. describe 2.14.1.9. link 2.14.1.10. list 2.14.1.11. log 2.14.1.12. login 2.14.1.13. logout 2.14.1.14. preference 2.14.1.15. project 2.14.1.16. push 2.14.1.17. registry 2.14.1.18. service 2.14.1.19. storage 2.14.1.20. unlink 2.14.1.21. update 2.14.1.22. url 2.14.1.23. utils 2.14.1.24. version 2.14.1.25. watch 2.15. odo release notes Expand section "2.15. odo release notes" Collapse section "2.15. odo release notes" 2.15.1. Notable changes and improvements in odo 2.15.2. Getting support 2.15.3. Known issues 2.15.4. Technology Preview features odo 3. Helm CLI Expand section "3. Helm CLI" Collapse section "3. Helm CLI" 3.1. Getting started with Helm 3 on OpenShift Container Platform Expand section "3.1. Getting started with Helm 3 on OpenShift Container Platform" Collapse section "3.1. Getting started with Helm 3 on OpenShift Container Platform" 3.1.1. Understanding Helm Expand section "3.1.1. Understanding Helm" Collapse section "3.1.1. Understanding Helm" 3.1.1.1. Key features 3.1.2. Installing Helm Expand section "3.1.2. Installing Helm" Collapse section "3.1.2. Installing Helm" 3.1.2.1. On Linux 3.1.2.2. On Windows 7/8 3.1.2.3. On Windows 10 3.1.2.4. On MacOS 3.1.3. Installing a Helm chart on an OpenShift Container Platform cluster 3.1.4. Creating a custom Helm chart on OpenShift Container Platform 4. Knative CLI (kn) for use with OpenShift Serverless Expand section "4. Knative CLI (kn) for use with OpenShift Serverless" Collapse section "4. Knative CLI (kn) for use with OpenShift Serverless" 4.1. Key features 4.2. Installing kn 5. Pipelines CLI (tkn) Expand section "5. Pipelines CLI (tkn)" Collapse section "5. Pipelines CLI (tkn)" 5.1. Installing tkn Expand section "5.1. Installing tkn" Collapse section "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 Expand section "5.2. Configuring the OpenShift Pipelines tkn CLI" Collapse section "5.2. Configuring the OpenShift Pipelines tkn CLI" 5.2.1. Enabling tab completion 5.3. OpenShift Pipelines tkn reference Expand section "5.3. OpenShift Pipelines tkn reference" Collapse section "5.3. OpenShift Pipelines tkn reference" 5.3.1. Basic syntax 5.3.2. Global options 5.3.3. Utility commands Expand section "5.3.3. Utility commands" Collapse section "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 Expand section "5.3.4. Pipelines management commands" Collapse section "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. PipelineRun commands Expand section "5.3.5. PipelineRun commands" Collapse section "5.3.5. PipelineRun 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 Expand section "5.3.6. Task management commands" Collapse section "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. TaskRun commands Expand section "5.3.7. TaskRun commands" Collapse section "5.3.7. TaskRun 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 Expand section "5.3.8. Condition management commands" Collapse section "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 Expand section "5.3.9. Pipeline Resource management commands" Collapse section "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 Expand section "5.3.10. ClusterTask management commands" Collapse section "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 Expand section "5.3.11. Trigger management commands" Collapse section "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. triggerbinding 5.3.11.6. triggerbinding delete 5.3.11.7. triggerbinding describe 5.3.11.8. triggerbinding list 5.3.11.9. triggertemplate 5.3.11.10. triggertemplate delete 5.3.11.11. triggertemplate describe 5.3.11.12. triggertemplate list 5.3.11.13. clustertriggerbinding 5.3.11.14. clustertriggerbinding delete 5.3.11.15. clustertriggerbinding describe 5.3.11.16. clustertriggerbinding list 法律通告 Settings Close Language: 日本語 简体中文 English Language: 日本語 简体中文 English Format: Multi-page Single-page Format: Multi-page Single-page Language and Page Formatting Options Language: 日本語 简体中文 English Language: 日本語 简体中文 English Format: Multi-page Single-page Format: Multi-page Single-page 4.2. Installing kn For information about installing kn for use with OpenShift Serverless, see the documentation on Installing the Knative CLI (kn). Previous Next