Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions admin_guide/building_dependency_trees.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ toc::[]
{product-title} uses xref:../dev_guide/builds/triggering_builds.adoc#image-change-triggers[image
change triggers] in a `BuildConfig` to detect when an
xref:../architecture/core_concepts/builds_and_image_streams.adoc#image-stream-tag[image
stream tag] has been updated. You can use the `oadm build-chain` command to
stream tag] has been updated. You can use the `oc adm build-chain` command to
build a dependency tree that identifies which
xref:../architecture/core_concepts/containers_and_images.adoc#docker-images[images]
would be affected by updating an image in a specified
Expand Down Expand Up @@ -46,21 +46,21 @@ The following table describes common `build-chain` usage and general syntax:

|Build the dependency tree for the *latest* tag in `<image-stream>`.
|----
$ oadm build-chain <image-stream>
$ oc adm build-chain <image-stream>
----

|Build the dependency tree for the *v2* tag in DOT format, and visualize it
using the DOT utility.
|----
$ oadm build-chain <image-stream>:v2 \
$ oc adm build-chain <image-stream>:v2 \
-o dot \
\| dot -T svg -o deps.svg
----

|Build the dependency tree across all projects for the specified image stream
tag found the *test* project.
|----
$ oadm build-chain <image-stream>:v1 \
$ oc adm build-chain <image-stream>:v1 \
-n test --all
----
|===
Expand Down
2 changes: 1 addition & 1 deletion admin_guide/cluster_capacity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ $ oc create sa cluster-capacity-sa
. Add the role to the service account:
+
----
$ oadm policy add-cluster-role-to-user cluster-capacity-role \
$ oc adm policy add-cluster-role-to-user cluster-capacity-role \
system:serviceaccount:default:cluster-capacity-sa
----

Expand Down
16 changes: 8 additions & 8 deletions admin_guide/manage_nodes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -181,14 +181,14 @@ $ oc label -h
To list all or selected pods on one or more nodes:

----
$ oadm manage-node <node1> <node2> \
$ oc adm manage-node <node1> <node2> \
--list-pods [--pod-selector=<pod_selector>] [-o json|yaml]
----

To list all or selected pods on selected nodes:

----
$ oadm manage-node --selector=<node_selector> \
$ oc adm manage-node --selector=<node_selector> \
--list-pods [--pod-selector=<pod_selector>] [-o json|yaml]
----

Expand All @@ -203,15 +203,15 @@ scheduled on the node. Existing pods on the node are not affected.
To mark a node or nodes as unschedulable:

----
$ oadm manage-node <node1> <node2> --schedulable=false
$ oc adm manage-node <node1> <node2> --schedulable=false
----

For example:

====
[options="nowrap"]
----
$ oadm manage-node node1.example.com --schedulable=false
$ oc adm manage-node node1.example.com --schedulable=false
NAME LABELS STATUS
node1.example.com kubernetes.io/hostname=node1.example.com Ready,SchedulingDisabled
----
Expand All @@ -220,7 +220,7 @@ node1.example.com kubernetes.io/hostname=node1.example.com Ready,Schedul
To mark a currently unschedulable node or nodes as schedulable:

----
$ oadm manage-node <node1> <node2> --schedulable
$ oc adm manage-node <node1> <node2> --schedulable
----

Alternatively, instead of specifying specific node names (e.g., `<node1>
Expand All @@ -245,21 +245,21 @@ To list pods that will be migrated without actually performing the evacuation,
use the `--dry-run` option:

----
$ oadm manage-node <node1> <node2> \
$ oc adm manage-node <node1> <node2> \
--evacuate --dry-run [--pod-selector=<pod_selector>]
----

To actually evacuate all or selected pods on one or more nodes:

----
$ oadm manage-node <node1> <node2> \
$ oc adm manage-node <node1> <node2> \
--evacuate [--pod-selector=<pod_selector>]
----

You can force deletion of bare pods by using the `--force` option:

----
$ oadm manage-node <node1> <node2> \
$ oc adm manage-node <node1> <node2> \
--evacuate --force [--pod-selector=<pod_selector>]
----

Expand Down
2 changes: 1 addition & 1 deletion admin_guide/manage_scc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ It is recommended that
xref:../architecture/additional_concepts/storage.adoc#architecture-additional-concepts-storage[persistent storage] using
`*PersistentVolume*` and `*PersistentVolumeClaim*` objects be used for
xref:../install_config/registry/index.adoc#install-config-registry-overview[registry deployments]. If
you are testing and would like to instead use the `oadm registry` command with
you are testing and would like to instead use the `oc adm registry` command with
the `--mount-host` option, you must first create a new
xref:service_accounts.adoc#admin-guide-service-accounts[service account] for the registry and add it to the
*privileged* SCC. See the
Expand Down
10 changes: 5 additions & 5 deletions admin_guide/managing_networking.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To join projects to an existing project network:

[source, bash]
----
$ oadm pod-network join-projects --to=<project1> <project2> <project3>
$ oc adm pod-network join-projects --to=<project1> <project2> <project3>
----

In the above example, all the pods and services in `<project2>` and `<project3>`
Expand All @@ -59,7 +59,7 @@ To isolate the project network in the cluster and vice versa, run:

[source, bash]
----
$ oadm pod-network isolate-projects <project1> <project2>
$ oc adm pod-network isolate-projects <project1> <project2>
----

In the above example, all of the pods and services in `<project1>` and
Expand All @@ -76,7 +76,7 @@ To allow projects to access all pods and services in the cluster and vice versa:

[source, bash]
----
$ oadm pod-network make-projects-global <project1> <project2>
$ oc adm pod-network make-projects-global <project1> <project2>
----

In the above example, all the pods and services in `<project1>` and `<project2>`
Expand Down Expand Up @@ -209,9 +209,9 @@ edit the ones you create in their project. There are also several other
restrictions on where `EgressNetworkPolicy` can be created:

* The `default` project (and any other project that has been made global via
`oadm pod-network make-projects-global`) cannot have egress policy.
`oc adm pod-network make-projects-global`) cannot have egress policy.

* If you merge two projects together (via `oadm pod-network join-projects`),
* If you merge two projects together (via `oc adm pod-network join-projects`),
then you cannot use egress policy in _any_ of the joined projects.

* No project may have more than one egress policy object.
Expand Down
14 changes: 7 additions & 7 deletions admin_guide/managing_projects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To create your own custom project template:
. Start with the current default project template:
+
----
$ oadm create-bootstrap-project-template -o yaml > template.yaml
$ oc adm create-bootstrap-project-template -o yaml > template.yaml
----

. Use a text editor to modify the *_template.yaml_* file by adding objects or modifying existing objects.
Expand Down Expand Up @@ -95,7 +95,7 @@ xref:../architecture/additional_concepts/authorization.adoc#roles[cluster role]
from authenticated user groups will deny permissions for self-provisioning any new projects.

----
$ oadm policy remove-cluster-role-from-group self-provisioner system:authenticated system:authenticated:oauth
$ oc adm policy remove-cluster-role-from-group self-provisioner system:authenticated system:authenticated:oauth
----

When disabling self-provisioning, set the `projectRequestMessage` parameter in the
Expand Down Expand Up @@ -172,7 +172,7 @@ The following creates a new project named `myproject` and dictates that pods be
deployed onto nodes labeled `user-node` and `east`:

----
$ oadm new-project myproject \
$ oc adm new-project myproject \
--node-selector='type=user-node,region=east'
----

Expand All @@ -181,14 +181,14 @@ all pods contained in the specified project.

[NOTE]
====
While the `new-project` subcommand is available for both `oadm` and `oc`, the
While the `new-project` subcommand is available for both `oc adm` and `oc`, the
cluster administrator and developer commands respectively, creating a new
project with a node selector is only available with the `oadm` command. The
project with a node selector is only available with the `oc adm` command. The
`new-project` subcommand is not available to project developers when
self-provisioning projects.
====

Using the `oadm new-project` command adds an `annotation` section to the
Using the `oc adm new-project` command adds an `annotation` section to the
project. You can edit a project, and change the `openshift.io/node-selector`
value to override the default:

Expand All @@ -200,7 +200,7 @@ metadata:
...
----

If `openshift.io/node-selector` is set to an empty string (`oadm new-project
If `openshift.io/node-selector` is set to an empty string (`oc adm new-project
--node-selector=""`), the project will not have an adminstrator-set node
selector, even if the cluster-wide default has been set. This means that, as a
cluster administrator, you can set a default to restrict developer projects to a
Expand Down
4 changes: 2 additions & 2 deletions admin_guide/monitoring_images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To view the usage statistics:

====
----
$ oadm top images
$ oc adm top images
NAME IMAGESTREAMTAG PARENTS USAGE METADATA STORAGE
sha256:80c985739a78b openshift/python (3.5) yes 303.12MiB
sha256:64461b5111fc7 openshift/ruby (2.2) yes 234.33MiB
Expand Down Expand Up @@ -59,7 +59,7 @@ To view the usage statistics:

====
----
$ oadm top imagestreams
$ oc adm top imagestreams
NAME STORAGE IMAGES LAYERS
openshift/python 1.21GiB 4 36
openshift/ruby 717.76MiB 3 27
Expand Down
28 changes: 14 additions & 14 deletions admin_guide/pruning_resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ still taking up disk space.
The CLI groups prune operations under a common parent command.

----
$ oadm prune <object_type> <options>
$ oc adm prune <object_type> <options>
----

This specifies:
Expand All @@ -45,7 +45,7 @@ In order to prune deployments that are no longer required by the system due to
age and status, administrators may run the following command:

----
$ oadm prune deployments [<options>]
$ oc adm prune deployments [<options>]
----

.Prune Deployments CLI Configuration Options
Expand Down Expand Up @@ -79,14 +79,14 @@ and hours (`h`).
To see what a pruning operation would delete:

----
$ oadm prune deployments --orphans --keep-complete=5 --keep-failed=1 \
$ oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 \
--keep-younger-than=60m
----

To actually perform the prune operation:

----
$ oadm prune deployments --orphans --keep-complete=5 --keep-failed=1 \
$ oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 \
--keep-younger-than=60m --confirm
----

Expand All @@ -98,7 +98,7 @@ In order to prune builds that are no longer required by the system due to age
and status, administrators may run the following command:

----
$ oadm prune builds [<options>]
$ oc adm prune builds [<options>]
----

.Prune Builds CLI Configuration Options
Expand Down Expand Up @@ -130,14 +130,14 @@ current time. (default `60m`)
To see what a pruning operation would delete:

----
$ oadm prune builds --orphans --keep-complete=5 --keep-failed=1 \
$ oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 \
--keep-younger-than=60m
----

To actually perform the prune operation:

----
$ oadm prune builds --orphans --keep-complete=5 --keep-failed=1 \
$ oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 \
--keep-younger-than=60m --confirm
----

Expand All @@ -155,7 +155,7 @@ In order to prune images that are no longer required by the system due to age,
status, or exceed limits, administrators may run the following command:

----
$ oadm prune images [<options>]
$ oc adm prune images [<options>]
----

[NOTE]
Expand Down Expand Up @@ -315,25 +315,25 @@ streams and pods) younger than sixty minutes:
+
====
----
$ oadm prune images --keep-tag-revisions=3 --keep-younger-than=60m
$ oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m
----
====

. Pruning every image that exceeds defined limits:
+
====
----
$ oadm prune images --prune-over-size-limit
$ oc adm prune images --prune-over-size-limit
----
====

To actually perform the prune operation for the previously mentioned options
accordingly:

----
$ oadm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm
$ oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm

$ oadm prune images --prune-over-size-limit --confirm
$ oc adm prune images --prune-over-size-limit --confirm
----

[[pruning-images-secure-or-insecure]]
Expand Down Expand Up @@ -399,7 +399,7 @@ When default options are used, the image will not ever be pruned because it
occurs at position `0` in a history of `myapp:v2.1-may-2016` tag. For an image to
be considered for pruning, the administrator must either:

. Specify `--keep-tag-revisions=0` with the `oadm prune images` command.
. Specify `--keep-tag-revisions=0` with the `oc adm prune images` command.
+
[CAUTION]
====
Expand Down Expand Up @@ -575,7 +575,7 @@ $ service_account=$(oc get -n default \
.. Add the *system:image-pruner* cluster role to the service account:
+
----
$ oadm policy add-cluster-role-to-user \
$ oc adm policy add-cluster-role-to-user \
system:image-pruner \
${service_account}
----
Expand Down
8 changes: 4 additions & 4 deletions admin_guide/router.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ To view HAProxy router stats:
using `--stats-port` to expose statistics on the specified port:
+
----
$ oadm router <name> --replicas=<number> --service-account=router --selector='<zone>' --stats-port=<port>
$ oc adm router <name> --replicas=<number> --service-account=router --selector='<zone>' --stats-port=<port>
----
+
For example:
+
----
$ oadm router router --replicas=1 --selector='zone=west' --stats-port=1936
$ oc adm router router --replicas=1 --selector='zone=west' --stats-port=1936
----
+
[NOTE]
Expand All @@ -48,7 +48,7 @@ $ oadm router router --replicas=1 --selector='zone=west' --stats-port=1936
`-selector` is used to filter nodes on deployment. Used to run routers on a specific set of nodes.
====
+
If you receive the following error, run the `oadm policy add-scc-to-user hostnetwork -z <name>` command as suggested.
If you receive the following error, run the `oc adm policy add-scc-to-user hostnetwork -z <name>` command as suggested.
+
----
error: router could not be created; service account "router" is not allowed to access the host network on nodes, grant access with oadm policy add-scc-to-user hostnetwork -z router
Expand Down Expand Up @@ -153,7 +153,7 @@ $ oc set env dc/router STATS_PORT=0
----

----
$ oadm router hap --service-account=router --stats-port=0
$ oc adm router hap --service-account=router --stats-port=0
----

[NOTE]
Expand Down
Loading