Skip to content

Commit 146481c

Browse files
authored
Merge pull request #57890 from bergerhoffer/OSDOCS-4864
OSDOCS-4864: Updating CLI ref docs for 4.13
2 parents f0c4288 + 7fabbe6 commit 146481c

File tree

2 files changed

+59
-17
lines changed

2 files changed

+59
-17
lines changed

modules/oc-adm-by-example-content.adoc

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,18 @@ Collect debugging data for a given resource
262262

263263

264264

265+
== oc adm migrate icsp
266+
Update imagecontentsourcepolicy file(s) to imagedigestmirrorset file(s).
267+
268+
.Example usage
269+
[source,bash,options="nowrap"]
270+
----
271+
# update the imagecontentsourcepolicy.yaml to new imagedigestmirrorset file under directory mydir
272+
oc adm migrate icsp imagecontentsourcepolicy.yaml --dest-dir mydir
273+
----
274+
275+
276+
265277
== oc adm migrate template-instances
266278
Update template instances to point to the latest group-version-kinds
267279

@@ -556,7 +568,7 @@ Extract the contents of an update payload to disk
556568
557569
# Use git to check out the source code for the current cluster release to DIR from linux/s390x image
558570
# Note: Wildcard filter is not supported. Pass a single os/arch to extract
559-
oc adm release extract --git=DIR quay.io/openshift-release-dev/ocp-release:4.2.2 --filter-by-os=linux/s390x
571+
oc adm release extract --git=DIR quay.io/openshift-release-dev/ocp-release:4.11.2 --filter-by-os=linux/s390x
560572
----
561573

562574

@@ -571,17 +583,17 @@ Display information about a release
571583
oc adm release info
572584
573585
# Show the source code that comprises a release
574-
oc adm release info 4.2.2 --commit-urls
586+
oc adm release info 4.11.2 --commit-urls
575587
576588
# Show the source code difference between two releases
577-
oc adm release info 4.2.0 4.2.2 --commits
589+
oc adm release info 4.11.0 4.11.2 --commits
578590
579591
# Show where the images referenced by the release are located
580-
oc adm release info quay.io/openshift-release-dev/ocp-release:4.2.2 --pullspecs
592+
oc adm release info quay.io/openshift-release-dev/ocp-release:4.11.2 --pullspecs
581593
582594
# Show information about linux/s390x image
583595
# Note: Wildcard filter is not supported. Pass a single os/arch to extract
584-
oc adm release info quay.io/openshift-release-dev/ocp-release:4.2.2 --filter-by-os=linux/s390x
596+
oc adm release info quay.io/openshift-release-dev/ocp-release:4.11.2 --filter-by-os=linux/s390x
585597
----
586598

587599

@@ -593,22 +605,22 @@ Mirror a release to a different image registry location
593605
[source,bash,options="nowrap"]
594606
----
595607
# Perform a dry run showing what would be mirrored, including the mirror objects
596-
oc adm release mirror 4.3.0 --to myregistry.local/openshift/release \
608+
oc adm release mirror 4.11.0 --to myregistry.local/openshift/release \
597609
--release-image-signature-to-dir /tmp/releases --dry-run
598610
599611
# Mirror a release into the current directory
600-
oc adm release mirror 4.3.0 --to file://openshift/release \
612+
oc adm release mirror 4.11.0 --to file://openshift/release \
601613
--release-image-signature-to-dir /tmp/releases
602614
603615
# Mirror a release to another directory in the default location
604-
oc adm release mirror 4.3.0 --to-dir /tmp/releases
616+
oc adm release mirror 4.11.0 --to-dir /tmp/releases
605617
606618
# Upload a release from the current directory to another server
607619
oc adm release mirror --from file://openshift/release --to myregistry.com/openshift/release \
608620
--release-image-signature-to-dir /tmp/releases
609621
610-
# Mirror the 4.3.0 release to repository registry.example.com and apply signatures to connected cluster
611-
oc adm release mirror --from=quay.io/openshift-release-dev/ocp-release:4.3.0-x86_64 \
622+
# Mirror the 4.11.0 release to repository registry.example.com and apply signatures to connected cluster
623+
oc adm release mirror --from=quay.io/openshift-release-dev/ocp-release:4.11.0-x86_64 \
612624
--to=registry.example.com/your/repository --apply-release-image-signature
613625
----
614626

@@ -621,18 +633,18 @@ Create a new OpenShift release
621633
[source,bash,options="nowrap"]
622634
----
623635
# Create a release from the latest origin images and push to a DockerHub repo
624-
oc adm release new --from-image-stream=4.1 -n origin --to-image docker.io/mycompany/myrepo:latest
636+
oc adm release new --from-image-stream=4.11 -n origin --to-image docker.io/mycompany/myrepo:latest
625637
626638
# Create a new release with updated metadata from a previous release
627-
oc adm release new --from-release registry.svc.ci.openshift.org/origin/release:v4.1 --name 4.1.1 \
628-
--previous 4.1.0 --metadata ... --to-image docker.io/mycompany/myrepo:latest
639+
oc adm release new --from-release registry.ci.openshift.org/origin/release:v4.11 --name 4.11.1 \
640+
--previous 4.11.0 --metadata ... --to-image docker.io/mycompany/myrepo:latest
629641
630642
# Create a new release and override a single image
631-
oc adm release new --from-release registry.svc.ci.openshift.org/origin/release:v4.1 \
643+
oc adm release new --from-release registry.ci.openshift.org/origin/release:v4.11 \
632644
cli=docker.io/mycompany/cli:latest --to-image docker.io/mycompany/myrepo:latest
633645
634646
# Run a verification pass to ensure the release can be reproduced
635-
oc adm release new --from-release registry.svc.ci.openshift.org/origin/release:v4.1
647+
oc adm release new --from-release registry.ci.openshift.org/origin/release:v4.11
636648
----
637649

638650

modules/oc-by-example-content.adoc

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Apply a configuration to a resource by file name or stdin
9999
oc apply --prune -f manifest.yaml -l app=nginx
100100
101101
# Apply the configuration in manifest.yaml and delete all the other config maps that are not in the file
102-
oc apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
102+
oc apply --prune -f manifest.yaml --all --prune-allowlist=core/v1/ConfigMap
103103
----
104104

105105

@@ -577,7 +577,7 @@ Display merged kubeconfig settings or a specified kubeconfig file
577577
# Show merged kubeconfig settings
578578
oc config view
579579
580-
# Show merged kubeconfig settings and raw certificate data
580+
# Show merged kubeconfig settings and raw certificate data and exposed secrets
581581
oc config view --raw
582582
583583
# Get the password for the e2e user
@@ -1320,6 +1320,30 @@ Edit a resource on the server
13201320

13211321

13221322

1323+
== oc events
1324+
List events
1325+
1326+
.Example usage
1327+
[source,bash,options="nowrap"]
1328+
----
1329+
# List recent events in the default namespace.
1330+
oc events
1331+
1332+
# List recent events in all namespaces.
1333+
oc events --all-namespaces
1334+
1335+
# List recent events for the specified pod, then wait for more events and list them as they arrive.
1336+
oc events --for pod/web-pod-13je7 --watch
1337+
1338+
# List recent events in given format. Supported ones, apart from default, are json and yaml.
1339+
oc events -oyaml
1340+
1341+
# List recent only events in given event types
1342+
oc events --types=Warning,Normal
1343+
----
1344+
1345+
1346+
13231347
== oc exec
13241348
Execute a command in a container
13251349

@@ -1649,6 +1673,9 @@ Import images from a container image registry
16491673
# Update imported data for all tags in an existing image stream
16501674
oc import-image mystream --all
16511675
1676+
# Update imported data for a tag which points to a manifest list to include the full manifest list
1677+
oc import-image mystream --import-mode=PreserveOriginal
1678+
16521679
# Import all tags into a new image stream
16531680
oc import-image mystream --from=registry.io/repo/image --all --confirm
16541681
@@ -2848,6 +2875,9 @@ Tag existing images into image streams
28482875
# Tag an external container image and request pullthrough for it
28492876
oc tag --source=docker openshift/origin-control-plane:latest yourproject/ruby:tip --reference-policy=local
28502877
2878+
# Tag an external container image and include the full manifest list
2879+
oc tag --source=docker openshift/origin-control-plane:latest yourproject/ruby:tip --import-mode=PreserveOriginal
2880+
28512881
# Remove the specified spec tag from an image stream
28522882
oc tag openshift/origin-control-plane:latest -d
28532883
----

0 commit comments

Comments
 (0)