mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
Terminology style updates for oc CLI book
This commit is contained in:
@@ -11,7 +11,7 @@ The `oc` binary offers the same capabilities as the `kubectl` binary, but it ext
|
||||
|
||||
* **Full support for {product-title} resources**
|
||||
+
|
||||
Resources such as DeploymentConfigs, BuildConfigs, Routes, ImageStreams, and ImageStreamTags are specific to {product-title} distributions, and build upon standard Kubernetes primitives.
|
||||
Resources such as `DeploymentConfig`, `BuildConfig`, `Route`, `ImageStream`, and `ImageStreamTag` objects are specific to {product-title} distributions, and build upon standard Kubernetes primitives.
|
||||
+
|
||||
* **Authentication**
|
||||
+
|
||||
|
||||
@@ -9,6 +9,6 @@ With the {product-title} command-line interface (CLI), you can create
|
||||
applications and manage {product-title} projects from a terminal. The CLI is
|
||||
ideal in situations where you:
|
||||
|
||||
* Work directly with project source code.
|
||||
* Script {product-title} operations.
|
||||
* Are restricted by bandwidth resources and can not use the web console.
|
||||
* work directly with project source code.
|
||||
* script {product-title} operations.
|
||||
* are restricted by bandwidth resources and can not use the web console.
|
||||
|
||||
@@ -26,7 +26,7 @@ $ oc adm migrate storage --include=pods
|
||||
|
||||
Remove older versions of resources from the server.
|
||||
|
||||
.Example: Prune older builds including those whose BuildConfigs no longer exist
|
||||
.Example: Prune older builds including those whose build configs no longer exist
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc adm prune builds --orphans
|
||||
|
||||
@@ -31,7 +31,7 @@ $ oc adm drain node1
|
||||
|
||||
Display and filter node logs.
|
||||
|
||||
.Example: Get logs for NetworkManager
|
||||
.Example: Get logs for `NetworkManager`
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc adm node-logs --role master -u NetworkManager.service
|
||||
|
||||
@@ -37,9 +37,9 @@ $ oc adm new-project myproject --node-selector='type=user-node,region=east'
|
||||
|
||||
== pod-network
|
||||
|
||||
Manage Pod networks in the cluster.
|
||||
Manage pod networks in the cluster.
|
||||
|
||||
.Example: Isolate project1 and project2 from other non-global projects
|
||||
.Example: Isolate `project1` and `project2` from other non-global projects
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc adm pod-network isolate-projects project1 project2
|
||||
|
||||
@@ -29,7 +29,7 @@ $ oc api-versions
|
||||
|
||||
Inspect permissions and reconcile RBAC roles.
|
||||
|
||||
.Example: Check whether the current user can read Pod logs
|
||||
.Example: Check whether the current user can read pod logs
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc auth can-i get pods --subresource=log
|
||||
@@ -64,16 +64,16 @@ $ oc convert -f pod.yaml
|
||||
|
||||
== extract
|
||||
|
||||
Extract the contents of a ConfigMap or secret. Each key in the ConfigMap or
|
||||
Extract the contents of a config map or secret. Each key in the config map 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
|
||||
.Example: Download the contents of the `ruby-1-ca` config map to the current directory
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc extract configmap/ruby-1-ca
|
||||
----
|
||||
|
||||
.Example: Print the contents of the `ruby-1-ca` ConfigMap to stdout
|
||||
.Example: Print the contents of the `ruby-1-ca` config map to stdout
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc extract configmap/ruby-1-ca --to=-
|
||||
@@ -81,10 +81,10 @@ $ oc extract configmap/ruby-1-ca --to=-
|
||||
|
||||
== idle
|
||||
|
||||
Idle scalable resources. An idled Service will automatically become unidled when
|
||||
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
|
||||
.Example: Idle the `ruby-app` service
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc idle ruby-app
|
||||
@@ -104,7 +104,7 @@ $ oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable
|
||||
|
||||
Observe changes to resources and take action on them.
|
||||
|
||||
.Example: Observe changes to Services
|
||||
.Example: Observe changes to services
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc observe services
|
||||
@@ -123,7 +123,7 @@ $ oc patch node/node1 -p '{"spec":{"unschedulable":true}}'
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you must patch a Custom Resource Definition, you must include the
|
||||
If you must patch a custom resource definition, you must include the
|
||||
`--type merge` option in the command.
|
||||
====
|
||||
|
||||
@@ -162,7 +162,7 @@ $ oc registry info
|
||||
Modify an existing object based on the contents of the specified configuration
|
||||
file.
|
||||
|
||||
.Example: Update a Pod using the content in `pod.json`
|
||||
.Example: Update a pod using the content in `pod.json`
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc replace -f pod.json
|
||||
|
||||
@@ -9,13 +9,13 @@
|
||||
|
||||
Update the annotations on one or more resources.
|
||||
|
||||
.Example: Add an annotation to a Route
|
||||
.Example: Add an annotation to a route
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"
|
||||
----
|
||||
|
||||
.Example: Remove the annotation from the Route
|
||||
.Example: Remove the annotation from the route
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-
|
||||
@@ -26,7 +26,7 @@ $ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-
|
||||
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
|
||||
.Example: Apply the configuration in `pod.json` to a pod
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f pod.json
|
||||
@@ -34,7 +34,7 @@ $ oc apply -f pod.json
|
||||
|
||||
== autoscale
|
||||
|
||||
Autoscale a DeploymentConfig or ReplicationController.
|
||||
Autoscale a deployment or replication controller.
|
||||
|
||||
.Example: Autoscale to a minimum of two and maximum of five pods
|
||||
[source,terminal]
|
||||
@@ -46,7 +46,7 @@ $ oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=5
|
||||
|
||||
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`
|
||||
.Example: Create a pod using the content in `pod.json`
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc create -f pod.json
|
||||
@@ -56,7 +56,7 @@ $ oc create -f pod.json
|
||||
|
||||
Delete a resource.
|
||||
|
||||
.Example: Delete a Pod named `parksmap-katacoda-1-qfqz4`
|
||||
.Example: Delete a pod named `parksmap-katacoda-1-qfqz4`
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc delete pod/parksmap-katacoda-1-qfqz4
|
||||
@@ -72,7 +72,7 @@ $ oc delete pods -l app=parksmap-katacoda
|
||||
|
||||
Return detailed information about a specific object.
|
||||
|
||||
.Example: Describe a Deployment named `example`
|
||||
.Example: Describe a deployment named `example`
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc describe deployment/example
|
||||
@@ -88,19 +88,19 @@ $ oc describe pods
|
||||
|
||||
Edit a resource.
|
||||
|
||||
.Example: Edit a DeploymentConfig using the default editor
|
||||
.Example: Edit a deployment using the default editor
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc edit deploymentconfig/parksmap-katacoda
|
||||
----
|
||||
|
||||
.Example: Edit a DeploymentConfig using a different editor
|
||||
.Example: Edit a deployment using a different editor
|
||||
[source,terminal]
|
||||
----
|
||||
$ OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacoda
|
||||
----
|
||||
|
||||
.Example: Edit a DeploymentConfig in JSON format
|
||||
.Example: Edit a deployment in JSON format
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc edit deploymentconfig/parksmap-katacoda -o json
|
||||
@@ -108,15 +108,15 @@ $ oc edit deploymentconfig/parksmap-katacoda -o json
|
||||
|
||||
== expose
|
||||
|
||||
Expose a Service externally as a Route.
|
||||
Expose a service externally as a route.
|
||||
|
||||
.Example: Expose a Service
|
||||
.Example: Expose a service
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc expose service/parksmap-katacoda
|
||||
----
|
||||
|
||||
.Example: Expose a Service and specify the host name
|
||||
.Example: Expose a service and specify the host name
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc expose service/parksmap-katacoda --hostname=www.my-host.com
|
||||
@@ -132,7 +132,7 @@ Display one or more resources.
|
||||
$ oc get pods -n default
|
||||
----
|
||||
|
||||
.Example: Get details about the `python` DeploymentConfig in JSON format
|
||||
.Example: Get details about the `python` deployment in JSON format
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get deploymentconfig/python -o json
|
||||
@@ -142,7 +142,7 @@ $ oc get deploymentconfig/python -o json
|
||||
|
||||
Update the labels on one or more resources.
|
||||
|
||||
.Example: Update the `python-1-mz2rf` Pod with the label `status` set to `unhealthy`
|
||||
.Example: Update the `python-1-mz2rf` pod with the label `status` set to `unhealthy`
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc label pod/python-1-mz2rf status=unhealthy
|
||||
@@ -150,10 +150,10 @@ $ oc label pod/python-1-mz2rf status=unhealthy
|
||||
|
||||
== scale
|
||||
|
||||
Set the desired number of replicas for a ReplicationController or a
|
||||
DeploymentConfig.
|
||||
Set the desired number of replicas for a replication controller or a
|
||||
deployment.
|
||||
|
||||
.Example: Scale the `ruby-app` DeploymentConfig to three pods
|
||||
.Example: Scale the `ruby-app` deployment to three pods
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc scale deploymentconfig/ruby-app --replicas=3
|
||||
@@ -184,7 +184,7 @@ $ oc serviceaccounts get-token default
|
||||
|
||||
Configure existing application resources.
|
||||
|
||||
.Example: Set the name of a secret on a BuildConfig
|
||||
.Example: Set the name of a secret on a build config
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc set build-secret --source buildconfig/mybc mysecret
|
||||
|
||||
@@ -15,7 +15,7 @@ Cancel a running, pending, or new build.
|
||||
$ oc cancel-build python-1
|
||||
----
|
||||
|
||||
.Example: Cancel all pending builds from the `python` BuildConfig
|
||||
.Example: Cancel all pending builds from the `python` build config
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc cancel-build buildconfig/python --state=pending
|
||||
@@ -33,15 +33,15 @@ $ oc import-image my-ruby
|
||||
|
||||
== new-build
|
||||
|
||||
Create a new `BuildConfig` from source code.
|
||||
Create a new build config from source code.
|
||||
|
||||
.Example: Create a BuildConfig from a local Git repository
|
||||
.Example: Create a build config from a local Git repository
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc new-build .
|
||||
----
|
||||
|
||||
.Example: Create a BuildConfig from a remote Git repository
|
||||
.Example: Create a build config from a remote Git repository
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc new-build https://github.com/sclorg/cakephp-ex
|
||||
@@ -49,9 +49,9 @@ $ oc new-build https://github.com/sclorg/cakephp-ex
|
||||
|
||||
== rollback
|
||||
|
||||
Revert an application back to a previous Deployment.
|
||||
Revert an application back to a previous deployment.
|
||||
|
||||
.Example: Roll back to the last successful Deployment
|
||||
.Example: Roll back to the last successful deployment
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc rollback php
|
||||
@@ -68,13 +68,13 @@ $ oc rollback php --to-version=3
|
||||
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
|
||||
.Example: Roll back to the last successful deployment
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc rollout undo deploymentconfig/php
|
||||
----
|
||||
|
||||
.Example: Start a new rollout for a DeploymentConfig with its latest state
|
||||
.Example: Start a new rollout for a deployment with its latest state
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc rollout latest deploymentconfig/php
|
||||
@@ -82,9 +82,9 @@ $ oc rollout latest deploymentconfig/php
|
||||
|
||||
== start-build
|
||||
|
||||
Start a build from a `BuildConfig` or copy an existing build.
|
||||
Start a build from a build config or copy an existing build.
|
||||
|
||||
.Example: Start a build from the specified BuildConfig
|
||||
.Example: Start a build from the specified build config
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc start-build python
|
||||
@@ -104,7 +104,7 @@ $ oc start-build python --env=mykey=myvalue
|
||||
|
||||
== tag
|
||||
|
||||
Tag existing images into imagestreams.
|
||||
Tag existing images into image streams.
|
||||
|
||||
.Example: Configure the `ruby` image's `latest` tag to refer to the image for the `2.0` tag
|
||||
[source,terminal]
|
||||
|
||||
@@ -29,7 +29,7 @@ $ oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.
|
||||
|
||||
Launch a command shell to debug a running application.
|
||||
|
||||
.Example: Debug the `python` Deployment
|
||||
.Example: Debug the `python` deployment
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc debug deploymentconfig/python
|
||||
@@ -47,10 +47,10 @@ $ oc exec python-1-mz2rf -c python ls
|
||||
|
||||
== logs
|
||||
|
||||
Retrieve the log output for a specific build, BuildConfig, DeploymentConfig, or
|
||||
Retrieve the log output for a specific build, build config, deployment, or
|
||||
pod.
|
||||
|
||||
.Example: Stream the latest logs from the `python` DeploymentConfig
|
||||
.Example: Stream the latest logs from the `python` deployment
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc logs -f deploymentconfig/python
|
||||
|
||||
@@ -93,7 +93,7 @@ Using project "my-project" on server "https://openshift.example.com:6443".
|
||||
== 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.
|
||||
as services, deployments, and build configs.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
|
||||
@@ -8,4 +8,4 @@
|
||||
|
||||
The `opm` CLI tool is provided by the Operator Framework for use with the Operator Bundle Format. This tool allows you to create and maintain catalogs of Operators from a list of bundles, called an _index_, that are similar to software repositories. The result is a container image, called an _index image_, which can be stored in a container registry and then installed on a cluster.
|
||||
|
||||
An index contains a database of pointers to Operator manifest content that can be queried through an included API that is served when the container image is run. On {product-title}, Operator Lifecycle Manager (OLM) can use the index image as a catalog by referencing it in a CatalogSource, which polls the image at regular intervals to enable frequent updates to installed Operators on the cluster.
|
||||
An index contains a database of pointers to Operator manifest content that can be queried through an included API that is served when the container image is run. On {product-title}, Operator Lifecycle Manager (OLM) can use the index image as a catalog by referencing it in a `CatalogSource` object, which polls the image at regular intervals to enable frequent updates to installed Operators on the cluster.
|
||||
|
||||
Reference in New Issue
Block a user