From 1587637da1c9bb41150c084c928c5983b877416e Mon Sep 17 00:00:00 2001 From: Fabiano Franz Date: Mon, 19 Sep 2016 12:41:35 -0300 Subject: [PATCH] Update generated docs --- docs/generated/oadm_by_example_content.adoc | 288 +++---- docs/generated/oc_by_example_content.adoc | 766 ++++++++---------- docs/man/man1/oadm-build-chain.1 | 8 +- docs/man/man1/oadm-ca-create-key-pair.1 | 8 +- docs/man/man1/oadm-ca-create-master-certs.1 | 59 +- docs/man/man1/oadm-ca-create-server-cert.1 | 20 +- docs/man/man1/oadm-ca-decrypt.1 | 11 +- docs/man/man1/oadm-ca-encrypt.1 | 11 +- docs/man/man1/oadm-completion.1 | 14 +- docs/man/man1/oadm-config-current-context.1 | 1 - docs/man/man1/oadm-config-set-cluster.1 | 4 +- docs/man/man1/oadm-config-set-context.1 | 4 +- docs/man/man1/oadm-config-set-credentials.1 | 13 +- docs/man/man1/oadm-config-set.1 | 4 +- docs/man/man1/oadm-config-unset.1 | 3 +- docs/man/man1/oadm-config-view.1 | 1 - docs/man/man1/oadm-config.1 | 4 +- docs/man/man1/oadm-cordon.1 | 6 +- docs/man/man1/oadm-create-api-client-config.1 | 4 +- docs/man/man1/oadm-create-error-template.1 | 17 +- docs/man/man1/oadm-create-key-pair.1 | 8 +- docs/man/man1/oadm-create-kubeconfig.1 | 44 +- docs/man/man1/oadm-create-login-template.1 | 18 +- docs/man/man1/oadm-create-master-certs.1 | 59 +- .../oadm-create-provider-selection-template.1 | 18 +- docs/man/man1/oadm-create-server-cert.1 | 20 +- docs/man/man1/oadm-diagnostics.1 | 39 +- docs/man/man1/oadm-drain.1 | 26 +- docs/man/man1/oadm-groups-new.1 | 4 +- docs/man/man1/oadm-groups-prune.1 | 15 +- docs/man/man1/oadm-groups-sync.1 | 17 +- docs/man/man1/oadm-ipfailover.1 | 19 +- docs/man/man1/oadm-manage-node.1 | 43 +- docs/man/man1/oadm-migrate-image-references.1 | 37 +- docs/man/man1/oadm-migrate-storage.1 | 24 +- docs/man/man1/oadm-new-project.1 | 4 +- .../man1/oadm-pod-network-isolate-projects.1 | 10 +- .../man/man1/oadm-pod-network-join-projects.1 | 10 +- .../oadm-pod-network-make-projects-global.1 | 10 +- docs/man/man1/oadm-policy-add-role-to-user.1 | 2 +- docs/man/man1/oadm-policy-add-scc-to-user.1 | 2 +- ...m-policy-reconcile-cluster-role-bindings.1 | 12 +- .../oadm-policy-reconcile-cluster-roles.1 | 10 +- docs/man/man1/oadm-policy-reconcile-sccs.1 | 11 +- docs/man/man1/oadm-policy.1 | 7 +- docs/man/man1/oadm-prune-builds.1 | 5 +- docs/man/man1/oadm-prune-deployments.1 | 5 +- docs/man/man1/oadm-prune-groups.1 | 15 +- docs/man/man1/oadm-prune-images.1 | 12 +- docs/man/man1/oadm-prune.1 | 3 +- docs/man/man1/oadm-registry.1 | 28 +- docs/man/man1/oadm-router.1 | 20 +- docs/man/man1/oadm-taint.1 | 25 +- docs/man/man1/oadm-top-images.1 | 3 +- docs/man/man1/oadm-top-imagestreams.1 | 3 +- docs/man/man1/oadm-top-node.1 | 11 +- docs/man/man1/oadm-top-pod.1 | 26 +- docs/man/man1/oadm-top.1 | 3 +- docs/man/man1/oadm-uncordon.1 | 6 +- docs/man/man1/oadm.1 | 3 +- docs/man/man1/oc-adm-build-chain.1 | 8 +- docs/man/man1/oc-adm-ca-create-key-pair.1 | 8 +- docs/man/man1/oc-adm-ca-create-master-certs.1 | 59 +- docs/man/man1/oc-adm-ca-create-server-cert.1 | 20 +- docs/man/man1/oc-adm-ca-decrypt.1 | 11 +- docs/man/man1/oc-adm-ca-encrypt.1 | 11 +- docs/man/man1/oc-adm-completion.1 | 14 +- docs/man/man1/oc-adm-config-current-context.1 | 1 - docs/man/man1/oc-adm-config-set-cluster.1 | 4 +- docs/man/man1/oc-adm-config-set-context.1 | 4 +- docs/man/man1/oc-adm-config-set-credentials.1 | 13 +- docs/man/man1/oc-adm-config-set.1 | 4 +- docs/man/man1/oc-adm-config-unset.1 | 3 +- docs/man/man1/oc-adm-config-view.1 | 1 - docs/man/man1/oc-adm-config.1 | 4 +- docs/man/man1/oc-adm-cordon.1 | 6 +- .../man1/oc-adm-create-api-client-config.1 | 4 +- docs/man/man1/oc-adm-create-error-template.1 | 17 +- docs/man/man1/oc-adm-create-key-pair.1 | 8 +- docs/man/man1/oc-adm-create-kubeconfig.1 | 44 +- docs/man/man1/oc-adm-create-login-template.1 | 18 +- docs/man/man1/oc-adm-create-master-certs.1 | 59 +- ...c-adm-create-provider-selection-template.1 | 18 +- docs/man/man1/oc-adm-create-server-cert.1 | 20 +- docs/man/man1/oc-adm-diagnostics.1 | 39 +- docs/man/man1/oc-adm-drain.1 | 26 +- docs/man/man1/oc-adm-groups-new.1 | 4 +- docs/man/man1/oc-adm-groups-prune.1 | 15 +- docs/man/man1/oc-adm-groups-sync.1 | 17 +- docs/man/man1/oc-adm-ipfailover.1 | 19 +- docs/man/man1/oc-adm-manage-node.1 | 43 +- .../man1/oc-adm-migrate-image-references.1 | 37 +- docs/man/man1/oc-adm-migrate-storage.1 | 24 +- docs/man/man1/oc-adm-new-project.1 | 4 +- .../oc-adm-pod-network-isolate-projects.1 | 10 +- .../man1/oc-adm-pod-network-join-projects.1 | 10 +- .../oc-adm-pod-network-make-projects-global.1 | 10 +- .../man/man1/oc-adm-policy-add-role-to-user.1 | 2 +- docs/man/man1/oc-adm-policy-add-scc-to-user.1 | 2 +- ...m-policy-reconcile-cluster-role-bindings.1 | 12 +- .../oc-adm-policy-reconcile-cluster-roles.1 | 10 +- docs/man/man1/oc-adm-policy-reconcile-sccs.1 | 11 +- docs/man/man1/oc-adm-policy.1 | 7 +- docs/man/man1/oc-adm-prune-builds.1 | 5 +- docs/man/man1/oc-adm-prune-deployments.1 | 5 +- docs/man/man1/oc-adm-prune-groups.1 | 15 +- docs/man/man1/oc-adm-prune-images.1 | 12 +- docs/man/man1/oc-adm-prune.1 | 3 +- docs/man/man1/oc-adm-registry.1 | 28 +- docs/man/man1/oc-adm-router.1 | 20 +- docs/man/man1/oc-adm-taint.1 | 25 +- docs/man/man1/oc-adm-top-images.1 | 3 +- docs/man/man1/oc-adm-top-imagestreams.1 | 3 +- docs/man/man1/oc-adm-top-node.1 | 11 +- docs/man/man1/oc-adm-top-pod.1 | 26 +- docs/man/man1/oc-adm-top.1 | 3 +- docs/man/man1/oc-adm-uncordon.1 | 6 +- docs/man/man1/oc-adm.1 | 3 +- docs/man/man1/oc-annotate.1 | 16 +- docs/man/man1/oc-apply.1 | 10 +- docs/man/man1/oc-attach.1 | 7 +- docs/man/man1/oc-autoscale.1 | 12 +- docs/man/man1/oc-cancel-build.1 | 11 +- docs/man/man1/oc-cluster-down.1 | 7 +- docs/man/man1/oc-cluster-up.1 | 24 +- docs/man/man1/oc-cluster.1 | 16 +- docs/man/man1/oc-completion.1 | 14 +- docs/man/man1/oc-config-current-context.1 | 1 - docs/man/man1/oc-config-set-cluster.1 | 4 +- docs/man/man1/oc-config-set-context.1 | 4 +- docs/man/man1/oc-config-set-credentials.1 | 13 +- docs/man/man1/oc-config-set.1 | 4 +- docs/man/man1/oc-config-unset.1 | 3 +- docs/man/man1/oc-config-view.1 | 1 - docs/man/man1/oc-config.1 | 4 +- docs/man/man1/oc-convert.1 | 15 +- docs/man/man1/oc-create-configmap.1 | 8 +- docs/man/man1/oc-create-deployment.1 | 1 - docs/man/man1/oc-create-identity.1 | 7 +- docs/man/man1/oc-create-imagestream.1 | 3 +- docs/man/man1/oc-create-namespace.1 | 1 - docs/man/man1/oc-create-route-edge.1 | 3 +- docs/man/man1/oc-create-route-passthrough.1 | 3 +- docs/man/man1/oc-create-route-reencrypt.1 | 4 +- docs/man/man1/oc-create-route.1 | 3 +- .../man1/oc-create-secret-docker-registry.1 | 10 +- docs/man/man1/oc-create-secret-generic.1 | 8 +- docs/man/man1/oc-create-secret-tls.1 | 1 - docs/man/man1/oc-create-service-clusterip.1 | 1 - .../man/man1/oc-create-service-loadbalancer.1 | 1 - docs/man/man1/oc-create-service-nodeport.1 | 1 - docs/man/man1/oc-create-serviceaccount.1 | 1 - docs/man/man1/oc-create-user.1 | 7 +- docs/man/man1/oc-create-useridentitymapping.1 | 5 +- docs/man/man1/oc-debug.1 | 26 +- docs/man/man1/oc-delete.1 | 17 +- docs/man/man1/oc-deploy.1 | 31 +- docs/man/man1/oc-describe.1 | 5 +- docs/man/man1/oc-edit.1 | 24 +- docs/man/man1/oc-env.1 | 18 +- docs/man/man1/oc-ex-dockerbuild.1 | 7 +- docs/man/man1/oc-exec.1 | 2 +- docs/man/man1/oc-explain.1 | 15 +- docs/man/man1/oc-export.1 | 18 +- docs/man/man1/oc-expose.1 | 12 +- docs/man/man1/oc-extract.1 | 11 +- docs/man/man1/oc-get.1 | 13 +- docs/man/man1/oc-idle.1 | 10 +- docs/man/man1/oc-import-app.json.1 | 11 +- docs/man/man1/oc-import-docker-compose.1 | 13 +- docs/man/man1/oc-import-image.1 | 3 +- docs/man/man1/oc-label.1 | 14 +- docs/man/man1/oc-login.1 | 13 +- docs/man/man1/oc-logout.1 | 9 +- docs/man/man1/oc-logs.1 | 18 +- docs/man/man1/oc-new-app.1 | 37 +- docs/man/man1/oc-new-build.1 | 24 +- docs/man/man1/oc-new-project.1 | 5 +- docs/man/man1/oc-observe.1 | 64 +- docs/man/man1/oc-policy-add-role-to-user.1 | 2 +- docs/man/man1/oc-port-forward.1 | 6 +- docs/man/man1/oc-process.1 | 17 +- docs/man/man1/oc-project.1 | 12 +- docs/man/man1/oc-projects.1 | 3 +- docs/man/man1/oc-proxy.1 | 4 +- docs/man/man1/oc-replace.1 | 4 +- docs/man/man1/oc-rollback.1 | 23 +- docs/man/man1/oc-rollout-history.1 | 5 +- docs/man/man1/oc-rollout-pause.1 | 3 +- docs/man/man1/oc-rollout-resume.1 | 3 +- docs/man/man1/oc-rollout-undo.1 | 19 +- docs/man/man1/oc-rsh.1 | 21 +- docs/man/man1/oc-rsync.1 | 13 +- docs/man/man1/oc-run.1 | 12 +- docs/man/man1/oc-scale.1 | 12 +- docs/man/man1/oc-secrets-add.1 | 4 +- docs/man/man1/oc-secrets-link.1 | 6 +- docs/man/man1/oc-secrets-new-basicauth.1 | 14 +- docs/man/man1/oc-secrets-new-dockercfg.1 | 15 +- docs/man/man1/oc-secrets-new-sshauth.1 | 14 +- docs/man/man1/oc-secrets-new.1 | 12 +- docs/man/man1/oc-secrets-unlink.1 | 4 +- docs/man/man1/oc-secrets.1 | 4 +- docs/man/man1/oc-serviceaccounts-get-token.1 | 5 +- docs/man/man1/oc-serviceaccounts-new-token.1 | 9 +- docs/man/man1/oc-set-build-hook.1 | 17 +- docs/man/man1/oc-set-deployment-hook.1 | 24 +- docs/man/man1/oc-set-env.1 | 29 +- docs/man/man1/oc-set-image.1 | 6 +- docs/man/man1/oc-set-probe.1 | 22 +- docs/man/man1/oc-set-route-backends.1 | 33 +- docs/man/man1/oc-set-triggers.1 | 23 +- docs/man/man1/oc-set-volumes.1 | 39 +- docs/man/man1/oc-start-build.1 | 21 +- docs/man/man1/oc-status.1 | 12 +- docs/man/man1/oc-tag.1 | 17 +- docs/man/man1/oc-types.1 | 11 +- docs/man/man1/oc-volumes.1 | 14 +- docs/man/man1/oc-whoami.1 | 4 +- docs/man/man1/oc.1 | 4 +- docs/man/man1/openshift-admin-build-chain.1 | 8 +- .../man1/openshift-admin-ca-create-key-pair.1 | 8 +- .../openshift-admin-ca-create-master-certs.1 | 59 +- .../openshift-admin-ca-create-server-cert.1 | 20 +- docs/man/man1/openshift-admin-ca-decrypt.1 | 11 +- docs/man/man1/openshift-admin-ca-encrypt.1 | 11 +- docs/man/man1/openshift-admin-completion.1 | 14 +- .../openshift-admin-config-current-context.1 | 1 - .../man1/openshift-admin-config-set-cluster.1 | 4 +- .../man1/openshift-admin-config-set-context.1 | 4 +- .../openshift-admin-config-set-credentials.1 | 13 +- docs/man/man1/openshift-admin-config-set.1 | 4 +- docs/man/man1/openshift-admin-config-unset.1 | 3 +- docs/man/man1/openshift-admin-config-view.1 | 1 - docs/man/man1/openshift-admin-config.1 | 4 +- docs/man/man1/openshift-admin-cordon.1 | 6 +- ...openshift-admin-create-api-client-config.1 | 4 +- .../openshift-admin-create-error-template.1 | 17 +- .../man1/openshift-admin-create-key-pair.1 | 8 +- .../man1/openshift-admin-create-kubeconfig.1 | 44 +- .../openshift-admin-create-login-template.1 | 18 +- .../openshift-admin-create-master-certs.1 | 59 +- ...admin-create-provider-selection-template.1 | 18 +- .../man1/openshift-admin-create-server-cert.1 | 20 +- docs/man/man1/openshift-admin-diagnostics.1 | 39 +- docs/man/man1/openshift-admin-drain.1 | 26 +- docs/man/man1/openshift-admin-groups-new.1 | 4 +- docs/man/man1/openshift-admin-groups-prune.1 | 15 +- docs/man/man1/openshift-admin-groups-sync.1 | 17 +- docs/man/man1/openshift-admin-ipfailover.1 | 19 +- docs/man/man1/openshift-admin-manage-node.1 | 43 +- ...openshift-admin-migrate-image-references.1 | 37 +- .../man1/openshift-admin-migrate-storage.1 | 24 +- docs/man/man1/openshift-admin-new-project.1 | 4 +- ...shift-admin-pod-network-isolate-projects.1 | 10 +- ...penshift-admin-pod-network-join-projects.1 | 10 +- ...t-admin-pod-network-make-projects-global.1 | 10 +- .../openshift-admin-policy-add-role-to-user.1 | 2 +- .../openshift-admin-policy-add-scc-to-user.1 | 2 +- ...n-policy-reconcile-cluster-role-bindings.1 | 12 +- ...ift-admin-policy-reconcile-cluster-roles.1 | 10 +- .../openshift-admin-policy-reconcile-sccs.1 | 11 +- docs/man/man1/openshift-admin-policy.1 | 7 +- docs/man/man1/openshift-admin-prune-builds.1 | 5 +- .../man1/openshift-admin-prune-deployments.1 | 5 +- docs/man/man1/openshift-admin-prune-groups.1 | 15 +- docs/man/man1/openshift-admin-prune-images.1 | 12 +- docs/man/man1/openshift-admin-prune.1 | 3 +- docs/man/man1/openshift-admin-registry.1 | 28 +- docs/man/man1/openshift-admin-router.1 | 20 +- docs/man/man1/openshift-admin-taint.1 | 25 +- docs/man/man1/openshift-admin-top-images.1 | 3 +- .../man1/openshift-admin-top-imagestreams.1 | 3 +- docs/man/man1/openshift-admin-top-node.1 | 11 +- docs/man/man1/openshift-admin-top-pod.1 | 26 +- docs/man/man1/openshift-admin-top.1 | 3 +- docs/man/man1/openshift-admin-uncordon.1 | 6 +- docs/man/man1/openshift-admin.1 | 3 +- docs/man/man1/openshift-cli-adm-build-chain.1 | 8 +- .../openshift-cli-adm-ca-create-key-pair.1 | 8 +- ...openshift-cli-adm-ca-create-master-certs.1 | 59 +- .../openshift-cli-adm-ca-create-server-cert.1 | 20 +- docs/man/man1/openshift-cli-adm-ca-decrypt.1 | 11 +- docs/man/man1/openshift-cli-adm-ca-encrypt.1 | 11 +- docs/man/man1/openshift-cli-adm-completion.1 | 14 +- ...openshift-cli-adm-config-current-context.1 | 1 - .../openshift-cli-adm-config-set-cluster.1 | 4 +- .../openshift-cli-adm-config-set-context.1 | 4 +- ...openshift-cli-adm-config-set-credentials.1 | 13 +- docs/man/man1/openshift-cli-adm-config-set.1 | 4 +- .../man/man1/openshift-cli-adm-config-unset.1 | 3 +- docs/man/man1/openshift-cli-adm-config-view.1 | 1 - docs/man/man1/openshift-cli-adm-config.1 | 4 +- docs/man/man1/openshift-cli-adm-cordon.1 | 6 +- ...enshift-cli-adm-create-api-client-config.1 | 4 +- .../openshift-cli-adm-create-error-template.1 | 17 +- .../man1/openshift-cli-adm-create-key-pair.1 | 8 +- .../openshift-cli-adm-create-kubeconfig.1 | 44 +- .../openshift-cli-adm-create-login-template.1 | 18 +- .../openshift-cli-adm-create-master-certs.1 | 59 +- ...i-adm-create-provider-selection-template.1 | 18 +- .../openshift-cli-adm-create-server-cert.1 | 20 +- docs/man/man1/openshift-cli-adm-diagnostics.1 | 39 +- docs/man/man1/openshift-cli-adm-drain.1 | 26 +- docs/man/man1/openshift-cli-adm-groups-new.1 | 4 +- .../man/man1/openshift-cli-adm-groups-prune.1 | 15 +- docs/man/man1/openshift-cli-adm-groups-sync.1 | 17 +- docs/man/man1/openshift-cli-adm-ipfailover.1 | 19 +- docs/man/man1/openshift-cli-adm-manage-node.1 | 43 +- ...enshift-cli-adm-migrate-image-references.1 | 37 +- .../man1/openshift-cli-adm-migrate-storage.1 | 24 +- docs/man/man1/openshift-cli-adm-new-project.1 | 4 +- ...ift-cli-adm-pod-network-isolate-projects.1 | 10 +- ...nshift-cli-adm-pod-network-join-projects.1 | 10 +- ...cli-adm-pod-network-make-projects-global.1 | 10 +- ...penshift-cli-adm-policy-add-role-to-user.1 | 2 +- ...openshift-cli-adm-policy-add-scc-to-user.1 | 2 +- ...m-policy-reconcile-cluster-role-bindings.1 | 12 +- ...t-cli-adm-policy-reconcile-cluster-roles.1 | 10 +- .../openshift-cli-adm-policy-reconcile-sccs.1 | 11 +- docs/man/man1/openshift-cli-adm-policy.1 | 7 +- .../man/man1/openshift-cli-adm-prune-builds.1 | 5 +- .../openshift-cli-adm-prune-deployments.1 | 5 +- .../man/man1/openshift-cli-adm-prune-groups.1 | 15 +- .../man/man1/openshift-cli-adm-prune-images.1 | 12 +- docs/man/man1/openshift-cli-adm-prune.1 | 3 +- docs/man/man1/openshift-cli-adm-registry.1 | 28 +- docs/man/man1/openshift-cli-adm-router.1 | 20 +- docs/man/man1/openshift-cli-adm-taint.1 | 25 +- docs/man/man1/openshift-cli-adm-top-images.1 | 3 +- .../man1/openshift-cli-adm-top-imagestreams.1 | 3 +- docs/man/man1/openshift-cli-adm-top-node.1 | 11 +- docs/man/man1/openshift-cli-adm-top-pod.1 | 26 +- docs/man/man1/openshift-cli-adm-top.1 | 3 +- docs/man/man1/openshift-cli-adm-uncordon.1 | 6 +- docs/man/man1/openshift-cli-adm.1 | 3 +- docs/man/man1/openshift-cli-annotate.1 | 16 +- docs/man/man1/openshift-cli-apply.1 | 10 +- docs/man/man1/openshift-cli-attach.1 | 7 +- docs/man/man1/openshift-cli-autoscale.1 | 12 +- docs/man/man1/openshift-cli-cancel-build.1 | 11 +- docs/man/man1/openshift-cli-cluster-down.1 | 7 +- docs/man/man1/openshift-cli-cluster-up.1 | 24 +- docs/man/man1/openshift-cli-cluster.1 | 16 +- docs/man/man1/openshift-cli-completion.1 | 14 +- .../openshift-cli-config-current-context.1 | 1 - .../man1/openshift-cli-config-set-cluster.1 | 4 +- .../man1/openshift-cli-config-set-context.1 | 4 +- .../openshift-cli-config-set-credentials.1 | 13 +- docs/man/man1/openshift-cli-config-set.1 | 4 +- docs/man/man1/openshift-cli-config-unset.1 | 3 +- docs/man/man1/openshift-cli-config-view.1 | 1 - docs/man/man1/openshift-cli-config.1 | 4 +- docs/man/man1/openshift-cli-convert.1 | 15 +- .../man/man1/openshift-cli-create-configmap.1 | 8 +- .../man1/openshift-cli-create-deployment.1 | 1 - docs/man/man1/openshift-cli-create-identity.1 | 7 +- .../man1/openshift-cli-create-imagestream.1 | 3 +- .../man/man1/openshift-cli-create-namespace.1 | 1 - .../man1/openshift-cli-create-route-edge.1 | 3 +- .../openshift-cli-create-route-passthrough.1 | 3 +- .../openshift-cli-create-route-reencrypt.1 | 4 +- docs/man/man1/openshift-cli-create-route.1 | 3 +- ...nshift-cli-create-secret-docker-registry.1 | 10 +- .../openshift-cli-create-secret-generic.1 | 8 +- .../man1/openshift-cli-create-secret-tls.1 | 1 - .../openshift-cli-create-service-clusterip.1 | 1 - ...penshift-cli-create-service-loadbalancer.1 | 1 - .../openshift-cli-create-service-nodeport.1 | 1 - .../openshift-cli-create-serviceaccount.1 | 1 - docs/man/man1/openshift-cli-create-user.1 | 7 +- ...openshift-cli-create-useridentitymapping.1 | 5 +- docs/man/man1/openshift-cli-debug.1 | 26 +- docs/man/man1/openshift-cli-delete.1 | 17 +- docs/man/man1/openshift-cli-deploy.1 | 31 +- docs/man/man1/openshift-cli-describe.1 | 5 +- docs/man/man1/openshift-cli-edit.1 | 24 +- docs/man/man1/openshift-cli-env.1 | 18 +- docs/man/man1/openshift-cli-ex-dockerbuild.1 | 7 +- docs/man/man1/openshift-cli-exec.1 | 2 +- docs/man/man1/openshift-cli-explain.1 | 15 +- docs/man/man1/openshift-cli-export.1 | 18 +- docs/man/man1/openshift-cli-expose.1 | 12 +- docs/man/man1/openshift-cli-extract.1 | 11 +- docs/man/man1/openshift-cli-get.1 | 13 +- docs/man/man1/openshift-cli-idle.1 | 10 +- docs/man/man1/openshift-cli-import-app.json.1 | 11 +- .../openshift-cli-import-docker-compose.1 | 13 +- docs/man/man1/openshift-cli-import-image.1 | 3 +- docs/man/man1/openshift-cli-label.1 | 14 +- docs/man/man1/openshift-cli-login.1 | 13 +- docs/man/man1/openshift-cli-logout.1 | 9 +- docs/man/man1/openshift-cli-logs.1 | 18 +- docs/man/man1/openshift-cli-new-app.1 | 37 +- docs/man/man1/openshift-cli-new-build.1 | 24 +- docs/man/man1/openshift-cli-new-project.1 | 5 +- docs/man/man1/openshift-cli-observe.1 | 64 +- .../openshift-cli-policy-add-role-to-user.1 | 2 +- docs/man/man1/openshift-cli-port-forward.1 | 6 +- docs/man/man1/openshift-cli-process.1 | 17 +- docs/man/man1/openshift-cli-project.1 | 12 +- docs/man/man1/openshift-cli-projects.1 | 3 +- docs/man/man1/openshift-cli-proxy.1 | 4 +- docs/man/man1/openshift-cli-replace.1 | 4 +- docs/man/man1/openshift-cli-rollback.1 | 23 +- docs/man/man1/openshift-cli-rollout-history.1 | 5 +- docs/man/man1/openshift-cli-rollout-pause.1 | 3 +- docs/man/man1/openshift-cli-rollout-resume.1 | 3 +- docs/man/man1/openshift-cli-rollout-undo.1 | 19 +- docs/man/man1/openshift-cli-rsh.1 | 21 +- docs/man/man1/openshift-cli-rsync.1 | 13 +- docs/man/man1/openshift-cli-run.1 | 12 +- docs/man/man1/openshift-cli-scale.1 | 12 +- docs/man/man1/openshift-cli-secrets-add.1 | 4 +- docs/man/man1/openshift-cli-secrets-link.1 | 6 +- .../openshift-cli-secrets-new-basicauth.1 | 14 +- .../openshift-cli-secrets-new-dockercfg.1 | 15 +- .../man1/openshift-cli-secrets-new-sshauth.1 | 14 +- docs/man/man1/openshift-cli-secrets-new.1 | 12 +- docs/man/man1/openshift-cli-secrets-unlink.1 | 4 +- docs/man/man1/openshift-cli-secrets.1 | 4 +- .../openshift-cli-serviceaccounts-get-token.1 | 5 +- .../openshift-cli-serviceaccounts-new-token.1 | 9 +- docs/man/man1/openshift-cli-set-build-hook.1 | 17 +- .../man1/openshift-cli-set-deployment-hook.1 | 24 +- docs/man/man1/openshift-cli-set-env.1 | 29 +- docs/man/man1/openshift-cli-set-image.1 | 6 +- docs/man/man1/openshift-cli-set-probe.1 | 22 +- .../man1/openshift-cli-set-route-backends.1 | 33 +- docs/man/man1/openshift-cli-set-triggers.1 | 23 +- docs/man/man1/openshift-cli-set-volumes.1 | 39 +- docs/man/man1/openshift-cli-start-build.1 | 21 +- docs/man/man1/openshift-cli-status.1 | 12 +- docs/man/man1/openshift-cli-tag.1 | 17 +- docs/man/man1/openshift-cli-types.1 | 11 +- docs/man/man1/openshift-cli-volumes.1 | 14 +- docs/man/man1/openshift-cli-whoami.1 | 4 +- docs/man/man1/openshift-cli.1 | 4 +- docs/man/man1/openshift-completion.1 | 14 +- docs/man/man1/openshift-ex-build-chain.1 | 8 +- docs/man/man1/openshift-ex-config-patch.1 | 5 +- docs/man/man1/openshift-ex-diagnostics.1 | 39 +- docs/man/man1/openshift-ex-ipfailover.1 | 19 +- docs/man/man1/openshift-ex-prune-groups.1 | 15 +- docs/man/man1/openshift-ex-sync-groups.1 | 17 +- .../openshift-ex-validate-master-config.1 | 2 +- .../man1/openshift-ex-validate-node-config.1 | 2 +- docs/man/man1/openshift-infra-deploy.1 | 7 +- .../man/man1/openshift-infra-diagnostic-pod.1 | 3 +- docs/man/man1/openshift-infra-docker-build.1 | 3 +- docs/man/man1/openshift-infra-f5-router.1 | 5 +- docs/man/man1/openshift-infra-router.1 | 11 +- docs/man/man1/openshift-infra-sti-build.1 | 3 +- docs/man/man1/openshift-start-etcd.1 | 6 +- docs/man/man1/openshift-start-master-api.1 | 3 +- .../man1/openshift-start-master-controllers.1 | 3 +- docs/man/man1/openshift-start-master.1 | 12 +- docs/man/man1/openshift-start-network.1 | 3 +- docs/man/man1/openshift-start-node.1 | 3 +- docs/man/man1/openshift-start.1 | 16 +- docs/man/man1/openshift.1 | 5 +- pkg/bootstrap/docker/openshift/admin.go | 7 +- pkg/cmd/cli/cli.go | 11 - pkg/cmd/cli/cmd/login/helpers.go | 7 +- pkg/cmd/cli/cmd/request_project.go | 2 +- 465 files changed, 2472 insertions(+), 4481 deletions(-) diff --git a/docs/generated/oadm_by_example_content.adoc b/docs/generated/oadm_by_example_content.adoc index 98ad13dfff8f..65d54cfa9538 100644 --- a/docs/generated/oadm_by_example_content.adoc +++ b/docs/generated/oadm_by_example_content.adoc @@ -13,10 +13,10 @@ Output the inputs and dependencies of your builds ---- # Build the dependency tree for the 'latest' tag in oadm build-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility oadm build-chain :v2 -o dot | dot -T svg -o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace oadm build-chain -n test --all ---- @@ -30,12 +30,11 @@ Decrypt data encrypted with "oadm ca encrypt" [options="nowrap"] ---- - # Decrypt an encrypted file to a cleartext file: - oadm ca decrypt --key=secret.key --in=secret.encrypted --out=secret.decrypted - - # Decrypt from stdin to stdout: - oadm ca decrypt --key=secret.key < secret2.encrypted > secret2.decrypted - + # Decrypt an encrypted file to a cleartext file: + oadm ca decrypt --key=secret.key --in=secret.encrypted --out=secret.decrypted + + # Decrypt from stdin to stdout: + oadm ca decrypt --key=secret.key < secret2.encrypted > secret2.decrypted ---- ==== @@ -47,12 +46,11 @@ Encrypt data with AES-256-CBC encryption [options="nowrap"] ---- - # Encrypt the content of secret.txt with a generated key: - oadm ca encrypt --genkey=secret.key --in=secret.txt --out=secret.encrypted - - # Encrypt the content of secret2.txt with an existing key: - oadm ca encrypt --key=secret.key < secret2.txt > secret2.encrypted - + # Encrypt the content of secret.txt with a generated key: + oadm ca encrypt --genkey=secret.key --in=secret.txt --out=secret.encrypted + + # Encrypt the content of secret2.txt with an existing key: + oadm ca encrypt --key=secret.key < secret2.txt > secret2.encrypted ---- ==== @@ -67,18 +65,19 @@ Output shell completion code for the given shell (bash or zsh) # Generate the oadm completion code for bash oadm completion bash > bash_completion.sh source bash_completion.sh - + # The above example depends on the bash-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash-completion source $(brew --prefix)/etc/bash_completion oadm completion bash > bash_completion.sh source bash_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(oadm completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 ---- ==== @@ -107,7 +106,6 @@ Displays the current-context [options="nowrap"] ---- - # Display the current-context oadm config current-context ---- @@ -137,7 +135,6 @@ Sets a cluster entry in kubeconfig [options="nowrap"] ---- - # Set only the server field on the e2e cluster entry without touching other values. oadm config set-cluster e2e --server=https://1.2.3.4 @@ -157,7 +154,6 @@ Sets a context entry in kubeconfig [options="nowrap"] ---- - # Set the user field on the gce context entry without touching other values oadm config set-context gce --user=cluster-admin ---- @@ -171,7 +167,6 @@ Sets a user entry in kubeconfig [options="nowrap"] ---- - # Set only the "client-key" field on the "cluster-admin" # entry, without touching other values: oadm config set-credentials cluster-admin --client-key=~/.kube/admin.key @@ -201,7 +196,6 @@ Display merged kubeconfig settings or a specified kubeconfig file [options="nowrap"] ---- - # Show Merged kubeconfig settings. oadm config view @@ -218,10 +212,8 @@ Mark node as unschedulable [options="nowrap"] ---- - -# Mark node "foo" as unschedulable. -oadm cordon foo - + # Mark node "foo" as unschedulable. + oadm cordon foo ---- ==== @@ -233,13 +225,11 @@ Drain node in preparation for maintenance [options="nowrap"] ---- - -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ oadm drain foo --force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ oadm drain foo --grace-period=900 - + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. + $ oadm drain foo --force + + # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. + $ oadm drain foo --grace-period=900 ---- ==== @@ -266,10 +256,10 @@ Create a new group ---- # Add a group with no users oadm groups new my-group - + # Add a group with two users oadm groups new my-group user1 user2 - + # Add a group with one user and shorter output oadm groups new my-group user1 -o name ---- @@ -285,16 +275,15 @@ Prune OpenShift groups referencing missing records on an external provider. ---- # Prune all orphaned groups oadm groups prune --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups except the ones from the blacklist file oadm groups prune --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oadm groups prune --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oadm groups prune groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm - ---- ==== @@ -321,19 +310,18 @@ Sync OpenShift groups with records from an external provider. ---- # Sync all groups from an LDAP server oadm groups sync --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server oadm groups sync --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Sync specific groups specified in a whitelist file with an LDAP server oadm groups sync --whitelist=/path/to/whitelist.txt --sync-config=/path/to/sync-config.yaml --confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server oadm groups sync --type=openshift --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server oadm groups sync groups/group1 groups/group2 groups/group3 --sync-config=/path/to/sync-config.yaml --confirm - ---- ==== @@ -347,18 +335,18 @@ Install an IP failover group to a set of nodes ---- # Check the default IP failover configuration ("ipfailover"): oadm ipfailover - + # See what the IP failover configuration would look like if it is created: oadm ipfailover -o json - + # Create an IP failover configuration if it does not already exist: oadm ipfailover ipf --virtual-ips="10.1.1.1-4" --create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us-west-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). oadm ipfailover ipfailover --selector="router=us-west-ha" --virtual-ips="1.2.3.4,10.1.1.100-104,5.6.7.8" --watch-port=80 --replicas=4 --create - + # Use a different IP failover config image and see the configuration: oadm ipfailover ipf-alt --selector="hagroup=us-west-ha" --virtual-ips="1.2.3.4" -o yaml --images=myrepo/myipfailover:mytag ---- @@ -372,26 +360,26 @@ Manage nodes - list pods, evacuate, or mark ready [options="nowrap"] ---- - # Block accepting any pods on given nodes - oadm manage-node --schedulable=false - - # Mark selected nodes as schedulable - oadm manage-node --selector="" --schedulable=true - - # Migrate selected pods - oadm manage-node --evacuate --pod-selector="" - - # Migrate selected pods, use a grace period of 60 seconds - oadm manage-node --evacuate --grace-period=60 --pod-selector="" - - # Migrate selected pods not backed by replication controller - oadm manage-node --evacuate --force --pod-selector="" - - # Show pods that will be migrated - oadm manage-node --evacuate --dry-run --pod-selector="" - - # List all pods on given nodes - oadm manage-node --list-pods + # Block accepting any pods on given nodes + oadm manage-node --schedulable=false + + # Mark selected nodes as schedulable + oadm manage-node --selector="" --schedulable=true + + # Migrate selected pods + oadm manage-node --evacuate --pod-selector="" + + # Migrate selected pods, use a grace period of 60 seconds + oadm manage-node --evacuate --grace-period=60 --pod-selector="" + + # Migrate selected pods not backed by replication controller + oadm manage-node --evacuate --force --pod-selector="" + + # Show pods that will be migrated + oadm manage-node --evacuate --dry-run --pod-selector="" + + # List all pods on given nodes + oadm manage-node --list-pods ---- ==== @@ -405,16 +393,16 @@ Update embedded Docker image references ---- # Perform a dry-run of migrating all "docker.io" references to "myregistry.com" oadm migrate image-references docker.io/*=myregistry.com/* - + # To actually perform the migration, the confirm flag must be appended oadm migrate image-references docker.io/*=myregistry.com/* --confirm - + # To see more details of what will be migrated, use the loglevel and output flags oadm migrate image-references docker.io/*=myregistry.com/* --loglevel=2 -o yaml - + # Migrate from a service IP to an internal service DNS name oadm migrate image-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* - + # Migrate from a service IP to an internal service DNS name for all deployment configs and builds oadm migrate image-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* --include=buildconfigs,deploymentconfigs ---- @@ -430,16 +418,15 @@ Update the stored version of API objects ---- # Perform a dry-run of updating all objects oadm migrate storage - + # To actually perform the update, the confirm flag must be appended oadm migrate storage --confirm - + # Only migrate pods oadm migrate storage --include=pods --confirm - + # Only pods that are in namespaces starting with "bar" oadm migrate storage --include=pods --confirm --from-key=bar/ --to-key=bar/\xFF - ---- ==== @@ -451,11 +438,11 @@ Isolate project network [options="nowrap"] ---- - # Provide isolation for project p1 - oadm pod-network isolate-projects - - # Allow all projects with label name=top-secret to have their own isolated project network - oadm pod-network isolate-projects --selector='name=top-secret' + # Provide isolation for project p1 + oadm pod-network isolate-projects + + # Allow all projects with label name=top-secret to have their own isolated project network + oadm pod-network isolate-projects --selector='name=top-secret' ---- ==== @@ -467,11 +454,11 @@ Join project network [options="nowrap"] ---- - # Allow project p2 to use project p1 network - oadm pod-network join-projects --to= - - # Allow all projects with label name=top-secret to use project p1 network - oadm pod-network join-projects --to= --selector='name=top-secret' + # Allow project p2 to use project p1 network + oadm pod-network join-projects --to= + + # Allow all projects with label name=top-secret to use project p1 network + oadm pod-network join-projects --to= --selector='name=top-secret' ---- ==== @@ -483,11 +470,11 @@ Make project network global [options="nowrap"] ---- - # Allow project p1 to access all pods in the cluster and vice versa - oadm pod-network make-projects-global - - # Allow all projects with label name=share to access all pods in the cluster and vice versa - oadm pod-network make-projects-global --selector='name=share' + # Allow project p1 to access all pods in the cluster and vice versa + oadm pod-network make-projects-global + + # Allow all projects with label name=share to access all pods in the cluster and vice versa + oadm pod-network make-projects-global --selector='name=share' ---- ==== @@ -501,7 +488,7 @@ Add a role to users or serviceaccounts for the current project ---- # Add the 'view' role to user1 for the current project oadm policy add-role-to-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project oadm policy add-role-to-user edit -z serviceaccount1 ---- @@ -517,7 +504,7 @@ Add users or serviceaccount to a security context constraint ---- # Add the 'restricted' security context contraint to user1 and user2 oadm policy add-scc-to-user restricted user1 user2 - + # Add the 'privileged' security context contraint to the service account serviceaccount1 in the current namespace oadm policy add-scc-to-user privileged -z serviceaccount1 ---- @@ -533,16 +520,16 @@ Update cluster role bindings to match the recommended bootstrap policy ---- # Display the names of cluster role bindings that would be modified oadm policy reconcile-cluster-role-bindings -o name - + # Display the cluster role bindings that would be modified, removing any extra subjects oadm policy reconcile-cluster-role-bindings --additive-only=false - + # Update cluster role bindings that don't match the current defaults oadm policy reconcile-cluster-role-bindings --confirm - + # Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group oadm policy reconcile-cluster-role-bindings --confirm --exclude-groups=system:authenticated - + # Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding oadm policy reconcile-cluster-role-bindings --confirm --additive-only=false ---- @@ -558,14 +545,14 @@ Update cluster roles to match the recommended bootstrap policy ---- # Display the names of cluster roles that would be modified oadm policy reconcile-cluster-roles -o name - + # Add missing permissions to cluster roles that don't match the current defaults oadm policy reconcile-cluster-roles --confirm - + # Add missing permissions and remove extra permissions from # cluster roles that don't match the current defaults oadm policy reconcile-cluster-roles --additive-only=false --confirm - + # Display the union of the default and modified cluster roles oadm policy reconcile-cluster-roles --additive-only ---- @@ -581,11 +568,11 @@ Replace cluster SCCs to match the recommended bootstrap policy ---- # Display the cluster SCCs that would be modified oadm policy reconcile-sccs - + # Update cluster SCCs that don't match the current defaults preserving additional grants # for users and group and keeping any priorities that are already set oadm policy reconcile-sccs --confirm - + # Replace existing users, groups, and priorities that do not match defaults oadm policy reconcile-sccs --additive-only=false --confirm ---- @@ -602,7 +589,7 @@ Remove old completed and failed builds # Dry run deleting older completed and failed builds and also including # all builds whose associated BuildConfig no longer exists oadm prune builds --orphans - + # To actually perform the prune operation, the confirm flag must be appended oadm prune builds --orphans --confirm ---- @@ -618,7 +605,7 @@ Remove old completed and failed deployments ---- # Dry run deleting all but the last complete deployment for every deployment config oadm prune deployments --keep-complete=1 - + # To actually perform the prune operation, the confirm flag must be appended oadm prune deployments --keep-complete=1 --confirm ---- @@ -634,16 +621,15 @@ Prune OpenShift groups referencing missing records on an external provider. ---- # Prune all orphaned groups oadm prune groups --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups except the ones from the blacklist file oadm prune groups --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oadm prune groups --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oadm prune groups groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm - ---- ==== @@ -658,14 +644,14 @@ Remove unreferenced images # See, what the prune command would delete if only images more than an hour old and obsoleted # by 3 newer revisions under the same tag were considered. oadm prune images --keep-tag-revisions=3 --keep-younger-than=60m - + # To actually perform the prune operation, the confirm flag must be appended oadm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm - + # See, what the prune command would delete if we're interested in removing images # exceeding currently set LimitRanges ('openshift.io/Image') oadm prune images --prune-over-size-limit - + # To actually perform the prune operation, the confirm flag must be appended oadm prune images --prune-over-size-limit --confirm ---- @@ -681,16 +667,16 @@ Install the integrated Docker registry ---- # Check if default Docker registry ("docker-registry") has been created oadm registry --dry-run - + # See what the registry will look like if created oadm registry -o yaml - + # Create a registry with two replicas if it does not exist oadm registry --replicas=2 - + # Use a different registry image oadm registry --images=myrepo/docker-registry:mytag - + # Enforce quota and limits on images oadm registry --enforce-quota ---- @@ -706,19 +692,18 @@ Install a router ---- # Check the default router ("router") oadm router --dry-run - + # See what the router would look like if created oadm router -o yaml - + # Create a router with two replicas if it does not exist oadm router router-west --replicas=2 - + # Use a different router image oadm router region-west --images=myrepo/somerouter:mytag - + # Run the router with a hint to the underlying implementation to _not_ expose statistics. oadm router router-west --stats-port=0 - ---- ==== @@ -730,16 +715,15 @@ Update the taints on one or more nodes [options="nowrap"] ---- - -# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. -# If a taint with that key and effect already exists, its value is replaced as specified. -oadm taint nodes foo dedicated=special-user:NoSchedule - -# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. -oadm taint nodes foo dedicated:NoSchedule- - -# Remove from node 'foo' all the taints with key 'dedicated' -oadm taint nodes foo dedicated- + # Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. + # If a taint with that key and effect already exists, its value is replaced as specified. + oadm taint nodes foo dedicated=special-user:NoSchedule + + # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. + oadm taint nodes foo dedicated:NoSchedule- + + # Remove from node 'foo' all the taints with key 'dedicated' + oadm taint nodes foo dedicated- ---- ==== @@ -777,12 +761,11 @@ Display Resource (CPU/Memory/Storage) usage of nodes [options="nowrap"] ---- - -# Show metrics for all nodes -kubectl top node - -# Show metrics for a given node -kubectl top node NODE_NAME + # Show metrics for all nodes + kubectl top node + + # Show metrics for a given node + kubectl top node NODE_NAME ---- ==== @@ -794,18 +777,17 @@ Display Resource (CPU/Memory/Storage) usage of pods [options="nowrap"] ---- - -# Show metrics for all pods in the default namespace -kubectl top pod - -# Show metrics for all pods in the given namespace -kubectl top pod --namespace=NAMESPACE - -# Show metrics for a given pod and its containers -kubectl top pod POD_NAME --containers - -# Show metrics for the pods defined by label name=myLabel -kubectl top pod -l name=myLabel + # Show metrics for all pods in the default namespace + kubectl top pod + + # Show metrics for all pods in the given namespace + kubectl top pod --namespace=NAMESPACE + + # Show metrics for a given pod and its containers + kubectl top pod POD_NAME --containers + + # Show metrics for the pods defined by label name=myLabel + kubectl top pod -l name=myLabel ---- ==== @@ -817,10 +799,8 @@ Mark node as schedulable [options="nowrap"] ---- - -# Mark node "foo" as schedulable. -$ oadm uncordon foo - + # Mark node "foo" as schedulable. + $ oadm uncordon foo ---- ==== diff --git a/docs/generated/oc_by_example_content.adoc b/docs/generated/oc_by_example_content.adoc index 0a7f3df64b10..4a3d27728ecd 100644 --- a/docs/generated/oc_by_example_content.adoc +++ b/docs/generated/oc_by_example_content.adoc @@ -13,10 +13,10 @@ Output the inputs and dependencies of your builds ---- # Build the dependency tree for the 'latest' tag in oc adm build-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility oc adm build-chain :v2 -o dot | dot -T svg -o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace oc adm build-chain -n test --all ---- @@ -30,12 +30,11 @@ Decrypt data encrypted with "oc adm ca encrypt" [options="nowrap"] ---- - # Decrypt an encrypted file to a cleartext file: - oc adm ca decrypt --key=secret.key --in=secret.encrypted --out=secret.decrypted - - # Decrypt from stdin to stdout: - oc adm ca decrypt --key=secret.key < secret2.encrypted > secret2.decrypted - + # Decrypt an encrypted file to a cleartext file: + oc adm ca decrypt --key=secret.key --in=secret.encrypted --out=secret.decrypted + + # Decrypt from stdin to stdout: + oc adm ca decrypt --key=secret.key < secret2.encrypted > secret2.decrypted ---- ==== @@ -47,12 +46,11 @@ Encrypt data with AES-256-CBC encryption [options="nowrap"] ---- - # Encrypt the content of secret.txt with a generated key: - oc adm ca encrypt --genkey=secret.key --in=secret.txt --out=secret.encrypted - - # Encrypt the content of secret2.txt with an existing key: - oc adm ca encrypt --key=secret.key < secret2.txt > secret2.encrypted - + # Encrypt the content of secret.txt with a generated key: + oc adm ca encrypt --genkey=secret.key --in=secret.txt --out=secret.encrypted + + # Encrypt the content of secret2.txt with an existing key: + oc adm ca encrypt --key=secret.key < secret2.txt > secret2.encrypted ---- ==== @@ -67,18 +65,19 @@ Output shell completion code for the given shell (bash or zsh) # Generate the oc adm completion code for bash oc adm completion bash > bash_completion.sh source bash_completion.sh - + # The above example depends on the bash-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash-completion source $(brew --prefix)/etc/bash_completion oc adm completion bash > bash_completion.sh source bash_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(oc adm completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 ---- ==== @@ -107,7 +106,6 @@ Displays the current-context [options="nowrap"] ---- - # Display the current-context oc adm config current-context ---- @@ -137,7 +135,6 @@ Sets a cluster entry in kubeconfig [options="nowrap"] ---- - # Set only the server field on the e2e cluster entry without touching other values. oc adm config set-cluster e2e --server=https://1.2.3.4 @@ -157,7 +154,6 @@ Sets a context entry in kubeconfig [options="nowrap"] ---- - # Set the user field on the gce context entry without touching other values oc adm config set-context gce --user=cluster-admin ---- @@ -171,7 +167,6 @@ Sets a user entry in kubeconfig [options="nowrap"] ---- - # Set only the "client-key" field on the "cluster-admin" # entry, without touching other values: oc adm config set-credentials cluster-admin --client-key=~/.kube/admin.key @@ -201,7 +196,6 @@ Display merged kubeconfig settings or a specified kubeconfig file [options="nowrap"] ---- - # Show Merged kubeconfig settings. oc adm config view @@ -218,10 +212,8 @@ Mark node as unschedulable [options="nowrap"] ---- - -# Mark node "foo" as unschedulable. -oc adm cordon foo - + # Mark node "foo" as unschedulable. + oc adm cordon foo ---- ==== @@ -233,13 +225,11 @@ Drain node in preparation for maintenance [options="nowrap"] ---- - -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ oc adm drain foo --force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ oc adm drain foo --grace-period=900 - + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. + $ oc adm drain foo --force + + # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. + $ oc adm drain foo --grace-period=900 ---- ==== @@ -266,10 +256,10 @@ Create a new group ---- # Add a group with no users oc adm groups new my-group - + # Add a group with two users oc adm groups new my-group user1 user2 - + # Add a group with one user and shorter output oc adm groups new my-group user1 -o name ---- @@ -285,16 +275,15 @@ Prune OpenShift groups referencing missing records on an external provider. ---- # Prune all orphaned groups oc adm groups prune --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups except the ones from the blacklist file oc adm groups prune --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oc adm groups prune --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oc adm groups prune groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm - ---- ==== @@ -321,19 +310,18 @@ Sync OpenShift groups with records from an external provider. ---- # Sync all groups from an LDAP server oc adm groups sync --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server oc adm groups sync --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Sync specific groups specified in a whitelist file with an LDAP server oc adm groups sync --whitelist=/path/to/whitelist.txt --sync-config=/path/to/sync-config.yaml --confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server oc adm groups sync --type=openshift --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server oc adm groups sync groups/group1 groups/group2 groups/group3 --sync-config=/path/to/sync-config.yaml --confirm - ---- ==== @@ -347,18 +335,18 @@ Install an IP failover group to a set of nodes ---- # Check the default IP failover configuration ("ipfailover"): oc adm ipfailover - + # See what the IP failover configuration would look like if it is created: oc adm ipfailover -o json - + # Create an IP failover configuration if it does not already exist: oc adm ipfailover ipf --virtual-ips="10.1.1.1-4" --create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us-west-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). oc adm ipfailover ipfailover --selector="router=us-west-ha" --virtual-ips="1.2.3.4,10.1.1.100-104,5.6.7.8" --watch-port=80 --replicas=4 --create - + # Use a different IP failover config image and see the configuration: oc adm ipfailover ipf-alt --selector="hagroup=us-west-ha" --virtual-ips="1.2.3.4" -o yaml --images=myrepo/myipfailover:mytag ---- @@ -372,26 +360,26 @@ Manage nodes - list pods, evacuate, or mark ready [options="nowrap"] ---- - # Block accepting any pods on given nodes - oc adm manage-node --schedulable=false - - # Mark selected nodes as schedulable - oc adm manage-node --selector="" --schedulable=true - - # Migrate selected pods - oc adm manage-node --evacuate --pod-selector="" - - # Migrate selected pods, use a grace period of 60 seconds - oc adm manage-node --evacuate --grace-period=60 --pod-selector="" - - # Migrate selected pods not backed by replication controller - oc adm manage-node --evacuate --force --pod-selector="" - - # Show pods that will be migrated - oc adm manage-node --evacuate --dry-run --pod-selector="" - - # List all pods on given nodes - oc adm manage-node --list-pods + # Block accepting any pods on given nodes + oc adm manage-node --schedulable=false + + # Mark selected nodes as schedulable + oc adm manage-node --selector="" --schedulable=true + + # Migrate selected pods + oc adm manage-node --evacuate --pod-selector="" + + # Migrate selected pods, use a grace period of 60 seconds + oc adm manage-node --evacuate --grace-period=60 --pod-selector="" + + # Migrate selected pods not backed by replication controller + oc adm manage-node --evacuate --force --pod-selector="" + + # Show pods that will be migrated + oc adm manage-node --evacuate --dry-run --pod-selector="" + + # List all pods on given nodes + oc adm manage-node --list-pods ---- ==== @@ -405,16 +393,16 @@ Update embedded Docker image references ---- # Perform a dry-run of migrating all "docker.io" references to "myregistry.com" oc adm migrate image-references docker.io/*=myregistry.com/* - + # To actually perform the migration, the confirm flag must be appended oc adm migrate image-references docker.io/*=myregistry.com/* --confirm - + # To see more details of what will be migrated, use the loglevel and output flags oc adm migrate image-references docker.io/*=myregistry.com/* --loglevel=2 -o yaml - + # Migrate from a service IP to an internal service DNS name oc adm migrate image-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* - + # Migrate from a service IP to an internal service DNS name for all deployment configs and builds oc adm migrate image-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* --include=buildconfigs,deploymentconfigs ---- @@ -430,16 +418,15 @@ Update the stored version of API objects ---- # Perform a dry-run of updating all objects oc adm migrate storage - + # To actually perform the update, the confirm flag must be appended oc adm migrate storage --confirm - + # Only migrate pods oc adm migrate storage --include=pods --confirm - + # Only pods that are in namespaces starting with "bar" oc adm migrate storage --include=pods --confirm --from-key=bar/ --to-key=bar/\xFF - ---- ==== @@ -451,11 +438,11 @@ Isolate project network [options="nowrap"] ---- - # Provide isolation for project p1 - oc adm pod-network isolate-projects - - # Allow all projects with label name=top-secret to have their own isolated project network - oc adm pod-network isolate-projects --selector='name=top-secret' + # Provide isolation for project p1 + oc adm pod-network isolate-projects + + # Allow all projects with label name=top-secret to have their own isolated project network + oc adm pod-network isolate-projects --selector='name=top-secret' ---- ==== @@ -467,11 +454,11 @@ Join project network [options="nowrap"] ---- - # Allow project p2 to use project p1 network - oc adm pod-network join-projects --to= - - # Allow all projects with label name=top-secret to use project p1 network - oc adm pod-network join-projects --to= --selector='name=top-secret' + # Allow project p2 to use project p1 network + oc adm pod-network join-projects --to= + + # Allow all projects with label name=top-secret to use project p1 network + oc adm pod-network join-projects --to= --selector='name=top-secret' ---- ==== @@ -483,11 +470,11 @@ Make project network global [options="nowrap"] ---- - # Allow project p1 to access all pods in the cluster and vice versa - oc adm pod-network make-projects-global - - # Allow all projects with label name=share to access all pods in the cluster and vice versa - oc adm pod-network make-projects-global --selector='name=share' + # Allow project p1 to access all pods in the cluster and vice versa + oc adm pod-network make-projects-global + + # Allow all projects with label name=share to access all pods in the cluster and vice versa + oc adm pod-network make-projects-global --selector='name=share' ---- ==== @@ -501,7 +488,7 @@ Add a role to users or serviceaccounts for the current project ---- # Add the 'view' role to user1 for the current project oc adm policy add-role-to-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project oc adm policy add-role-to-user edit -z serviceaccount1 ---- @@ -517,7 +504,7 @@ Add users or serviceaccount to a security context constraint ---- # Add the 'restricted' security context contraint to user1 and user2 oc adm policy add-scc-to-user restricted user1 user2 - + # Add the 'privileged' security context contraint to the service account serviceaccount1 in the current namespace oc adm policy add-scc-to-user privileged -z serviceaccount1 ---- @@ -533,16 +520,16 @@ Update cluster role bindings to match the recommended bootstrap policy ---- # Display the names of cluster role bindings that would be modified oc adm policy reconcile-cluster-role-bindings -o name - + # Display the cluster role bindings that would be modified, removing any extra subjects oc adm policy reconcile-cluster-role-bindings --additive-only=false - + # Update cluster role bindings that don't match the current defaults oc adm policy reconcile-cluster-role-bindings --confirm - + # Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group oc adm policy reconcile-cluster-role-bindings --confirm --exclude-groups=system:authenticated - + # Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding oc adm policy reconcile-cluster-role-bindings --confirm --additive-only=false ---- @@ -558,14 +545,14 @@ Update cluster roles to match the recommended bootstrap policy ---- # Display the names of cluster roles that would be modified oc adm policy reconcile-cluster-roles -o name - + # Add missing permissions to cluster roles that don't match the current defaults oc adm policy reconcile-cluster-roles --confirm - + # Add missing permissions and remove extra permissions from # cluster roles that don't match the current defaults oc adm policy reconcile-cluster-roles --additive-only=false --confirm - + # Display the union of the default and modified cluster roles oc adm policy reconcile-cluster-roles --additive-only ---- @@ -581,11 +568,11 @@ Replace cluster SCCs to match the recommended bootstrap policy ---- # Display the cluster SCCs that would be modified oc adm policy reconcile-sccs - + # Update cluster SCCs that don't match the current defaults preserving additional grants # for users and group and keeping any priorities that are already set oc adm policy reconcile-sccs --confirm - + # Replace existing users, groups, and priorities that do not match defaults oc adm policy reconcile-sccs --additive-only=false --confirm ---- @@ -602,7 +589,7 @@ Remove old completed and failed builds # Dry run deleting older completed and failed builds and also including # all builds whose associated BuildConfig no longer exists oc adm prune builds --orphans - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune builds --orphans --confirm ---- @@ -618,7 +605,7 @@ Remove old completed and failed deployments ---- # Dry run deleting all but the last complete deployment for every deployment config oc adm prune deployments --keep-complete=1 - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune deployments --keep-complete=1 --confirm ---- @@ -634,16 +621,15 @@ Prune OpenShift groups referencing missing records on an external provider. ---- # Prune all orphaned groups oc adm prune groups --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups except the ones from the blacklist file oc adm prune groups --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oc adm prune groups --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oc adm prune groups groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm - ---- ==== @@ -658,14 +644,14 @@ Remove unreferenced images # See, what the prune command would delete if only images more than an hour old and obsoleted # by 3 newer revisions under the same tag were considered. oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm - + # See, what the prune command would delete if we're interested in removing images # exceeding currently set LimitRanges ('openshift.io/Image') oc adm prune images --prune-over-size-limit - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune images --prune-over-size-limit --confirm ---- @@ -681,16 +667,16 @@ Install the integrated Docker registry ---- # Check if default Docker registry ("docker-registry") has been created oc adm registry --dry-run - + # See what the registry will look like if created oc adm registry -o yaml - + # Create a registry with two replicas if it does not exist oc adm registry --replicas=2 - + # Use a different registry image oc adm registry --images=myrepo/docker-registry:mytag - + # Enforce quota and limits on images oc adm registry --enforce-quota ---- @@ -706,19 +692,18 @@ Install a router ---- # Check the default router ("router") oc adm router --dry-run - + # See what the router would look like if created oc adm router -o yaml - + # Create a router with two replicas if it does not exist oc adm router router-west --replicas=2 - + # Use a different router image oc adm router region-west --images=myrepo/somerouter:mytag - + # Run the router with a hint to the underlying implementation to _not_ expose statistics. oc adm router router-west --stats-port=0 - ---- ==== @@ -730,16 +715,15 @@ Update the taints on one or more nodes [options="nowrap"] ---- - -# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. -# If a taint with that key and effect already exists, its value is replaced as specified. -oc adm taint nodes foo dedicated=special-user:NoSchedule - -# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. -oc adm taint nodes foo dedicated:NoSchedule- - -# Remove from node 'foo' all the taints with key 'dedicated' -oc adm taint nodes foo dedicated- + # Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. + # If a taint with that key and effect already exists, its value is replaced as specified. + oc adm taint nodes foo dedicated=special-user:NoSchedule + + # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. + oc adm taint nodes foo dedicated:NoSchedule- + + # Remove from node 'foo' all the taints with key 'dedicated' + oc adm taint nodes foo dedicated- ---- ==== @@ -777,12 +761,11 @@ Display Resource (CPU/Memory/Storage) usage of nodes [options="nowrap"] ---- - -# Show metrics for all nodes -kubectl top node - -# Show metrics for a given node -kubectl top node NODE_NAME + # Show metrics for all nodes + kubectl top node + + # Show metrics for a given node + kubectl top node NODE_NAME ---- ==== @@ -794,18 +777,17 @@ Display Resource (CPU/Memory/Storage) usage of pods [options="nowrap"] ---- - -# Show metrics for all pods in the default namespace -kubectl top pod - -# Show metrics for all pods in the given namespace -kubectl top pod --namespace=NAMESPACE - -# Show metrics for a given pod and its containers -kubectl top pod POD_NAME --containers - -# Show metrics for the pods defined by label name=myLabel -kubectl top pod -l name=myLabel + # Show metrics for all pods in the default namespace + kubectl top pod + + # Show metrics for all pods in the given namespace + kubectl top pod --namespace=NAMESPACE + + # Show metrics for a given pod and its containers + kubectl top pod POD_NAME --containers + + # Show metrics for the pods defined by label name=myLabel + kubectl top pod -l name=myLabel ---- ==== @@ -817,10 +799,8 @@ Mark node as schedulable [options="nowrap"] ---- - -# Mark node "foo" as schedulable. -$ oc adm uncordon foo - + # Mark node "foo" as schedulable. + $ oc adm uncordon foo ---- ==== @@ -835,17 +815,17 @@ Update the annotations on a resource # Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied oc annotate pods foo description='my frontend' - + # Update pod 'foo' with the annotation 'description' and the value # 'my frontend running nginx', overwriting any existing value. oc annotate --overwrite pods foo description='my frontend running nginx' - + # Update all pods in the namespace oc annotate pods --all description='my frontend running nginx' - + # Update pod 'foo' only if the resource is unchanged from version 1. oc annotate pods foo description='my frontend running nginx' --resource-version=1 - + # Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag. oc annotate pods foo description- @@ -860,11 +840,11 @@ Apply a configuration to a resource by filename or stdin [options="nowrap"] ---- -# Apply the configuration in pod.json to a pod. -oc apply -f ./pod.json - -# Apply the JSON passed into stdin to a pod. -cat pod.json | oc apply -f - + # Apply the configuration in pod.json to a pod. + oc apply -f ./pod.json + + # Apply the JSON passed into stdin to a pod. + cat pod.json | oc apply -f - ---- ==== @@ -878,10 +858,10 @@ Attach to a running container ---- # Get output from running pod 123456-7890, using the first container by default oc attach 123456-7890 - + # Get output from ruby-container from pod 123456-7890 oc attach 123456-7890 -c ruby-container - + # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 # and sends stdout/stderr from 'bash' back to the client oc attach 123456-7890 -c ruby-container -i -t @@ -896,10 +876,12 @@ Autoscale a deployment config or replication controller [options="nowrap"] ---- - # Auto scale a deployment config "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: + # Auto scale a deployment config "foo", with the number of pods between 2 to + # 10, target CPU utilization at a default value that server applies: oc autoscale dc/foo --min=2 --max=10 - - # Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80% + + # Auto scale a replication controller "foo", with the number of pods between + # 1 to 5, target CPU utilization at 80% oc autoscale rc/foo --max=5 --cpu-percent=80 ---- ==== @@ -914,16 +896,16 @@ Cancel running, pending, or new builds ---- # Cancel the build with the given name oc cancel-build ruby-build-2 - + # Cancel the named build and print the build logs oc cancel-build ruby-build-2 --dump-logs - + # Cancel the named build and create a new one with the same parameters oc cancel-build ruby-build-2 --restart - + # Cancel multiple builds oc cancel-build ruby-build-1 ruby-build-2 ruby-build-3 - + # Cancel all builds created from 'ruby-build' build configuration that are in 'new' state oc cancel-build bc/ruby-build --state=new ---- @@ -937,13 +919,11 @@ Stop OpenShift on Docker [options="nowrap"] ---- - # Stop local Docker cluster oc cluster down - + # Stop cluster running on Docker machine 'mymachine' oc cluster down --docker-machine=mymachine - ---- ==== @@ -955,19 +935,17 @@ Start OpenShift on Docker with reasonable defaults [options="nowrap"] ---- - # Start OpenShift on a new docker machine named 'openshift' oc cluster up --create-machine - + # Start OpenShift using a specific public host name oc cluster up --public-hostname=my.address.example.com - + # Start OpenShift and preserve data and config between restarts oc cluster up --host-data-dir=/mydata --use-existing-config - + # Use a different set of images oc cluster up --image="registry.example.com/origin" --version="v1.1" - ---- ==== @@ -982,18 +960,19 @@ Output shell completion code for the given shell (bash or zsh) # Generate the oc completion code for bash oc completion bash > bash_completion.sh source bash_completion.sh - + # The above example depends on the bash-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash-completion source $(brew --prefix)/etc/bash_completion oc completion bash > bash_completion.sh source bash_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(oc completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 ---- ==== @@ -1022,7 +1001,6 @@ Displays the current-context [options="nowrap"] ---- - # Display the current-context oc config current-context ---- @@ -1052,7 +1030,6 @@ Sets a cluster entry in kubeconfig [options="nowrap"] ---- - # Set only the server field on the e2e cluster entry without touching other values. oc config set-cluster e2e --server=https://1.2.3.4 @@ -1072,7 +1049,6 @@ Sets a context entry in kubeconfig [options="nowrap"] ---- - # Set the user field on the gce context entry without touching other values oc config set-context gce --user=cluster-admin ---- @@ -1086,7 +1062,6 @@ Sets a user entry in kubeconfig [options="nowrap"] ---- - # Set only the "client-key" field on the "cluster-admin" # entry, without touching other values: oc config set-credentials cluster-admin --client-key=~/.kube/admin.key @@ -1116,7 +1091,6 @@ Display merged kubeconfig settings or a specified kubeconfig file [options="nowrap"] ---- - # Show Merged kubeconfig settings. oc config view @@ -1135,14 +1109,13 @@ Convert config files between different API versions ---- # Convert 'pod.yaml' to latest version and print to stdout. oc convert -f pod.yaml - + # Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in json format. oc convert -f pod.yaml --local -o json - + # Convert all files under current directory to latest version and create them all. oc convert -f . | oc create -f - - ---- ==== @@ -1183,7 +1156,6 @@ Create a configmap from a local file, directory or literal value [options="nowrap"] ---- - # Create a new configmap named my-config with keys for each file in folder bar oc create configmap my-config --from-file=path/to/bar @@ -1203,7 +1175,6 @@ Create a deployment with the specified name. [options="nowrap"] ---- - # Create a new deployment named my-dep that runs the busybox image. oc create deployment my-dep --image=busybox ---- @@ -1256,7 +1227,6 @@ Create a namespace with the specified name [options="nowrap"] ---- - # Create a new namespace named my-namespace oc create namespace my-namespace ---- @@ -1350,7 +1320,6 @@ Create a secret for use with a Docker registry [options="nowrap"] ---- - # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: oc create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL ---- @@ -1364,7 +1333,6 @@ Create a secret from a local file, directory or literal value [options="nowrap"] ---- - # Create a new secret named my-secret with keys for each file in folder bar oc create secret generic my-secret --from-file=path/to/bar @@ -1384,7 +1352,6 @@ Create a TLS secret [options="nowrap"] ---- - # Create a new TLS secret named tls-secret with the given key pair: oc create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key ---- @@ -1398,7 +1365,6 @@ Create a clusterIP service. [options="nowrap"] ---- - # Create a new clusterIP service named my-cs oc create service clusterip my-cs --tcp=5678:8080 @@ -1415,7 +1381,6 @@ Create a LoadBalancer service. [options="nowrap"] ---- - # Create a new nodeport service named my-lbs oc create service loadbalancer my-lbs --tcp=5678:8080 ---- @@ -1429,7 +1394,6 @@ Create a NodePort service. [options="nowrap"] ---- - # Create a new nodeport service named my-ns oc create service nodeport my-ns --tcp=5678:8080 ---- @@ -1443,7 +1407,6 @@ Create a service account with the specified name [options="nowrap"] ---- - # Create a new service account named my-service-account $ oc create serviceaccount my-service-account ---- @@ -1483,16 +1446,15 @@ Launch a new instance of a pod for debugging [options="nowrap"] ---- - # Debug a currently running deployment oc debug dc/test - + # Test running a deployment as a non-root user oc debug dc/test --as-user=1000000 - + # Debug a specific failing container by running the env command in the 'second' container oc debug dc/test -c second -- /bin/env - + # See the pod that would be created to debug oc debug dc/test -o yaml ---- @@ -1508,21 +1470,21 @@ Delete one or more resources ---- # Delete a pod using the type and ID specified in pod.json. oc delete -f pod.json - + # Delete a pod based on the type and ID in the JSON passed into stdin. cat pod.json | oc delete -f - - + # Delete pods and services with label name=myLabel. oc delete pods,services -l name=myLabel - + # Delete a pod with name node-1-vsjnm. oc delete pod node-1-vsjnm - + # Delete all resources associated with a running app, includes # buildconfig,deploymentconfig,service,imagestream,route and pod, # where 'appName' is listed in 'Labels' of 'oc describe [resource] [resource name]' output. oc delete all -l app=appName - + # Delete all pods oc delete pods --all ---- @@ -1538,17 +1500,17 @@ View, start, cancel, or retry a deployment ---- # Display the latest deployment for the 'database' deployment config oc deploy database - + # Start a new deployment based on the 'database' oc deploy database --latest - + # Start a new deployment and follow its log oc deploy database --latest --follow - + # Retry the latest failed deployment based on 'frontend' # The deployer pod and any hook pods are deleted for the latest failed deployment oc deploy frontend --retry - + # Cancel the in-progress deployment based on 'frontend' oc deploy frontend --cancel ---- @@ -1564,7 +1526,7 @@ Show details of a specific resource or group of resources ---- # Provide details about the ruby-22-centos7 image repository oc describe imageRepository ruby-22-centos7 - + # Provide details about the ruby-sample-build build configuration oc describe bc ruby-sample-build ---- @@ -1580,13 +1542,13 @@ Edit a resource on the server ---- # Edit the service named 'docker-registry': oc edit svc/docker-registry - + # Edit the DeploymentConfig named 'my-deployment': oc edit dc/my-deployment - + # Use an alternative editor OC_EDITOR="nano" oc edit dc/my-deployment - + # Edit the service 'docker-registry' in JSON using the v1 API format: oc edit svc/docker-registry --output-version=v1 -o json ---- @@ -1602,32 +1564,32 @@ DEPRECATED: set env ---- # Update deployment 'registry' with a new environment variable oc env dc/registry STORAGE_DIR=/local - + # List the environment variables defined on a build config 'sample-build' oc env bc/sample-build --list - + # List the environment variables defined on all pods oc env pods --all --list - + # Output modified build config in YAML, and does not alter the object on the server oc env bc/sample-build STORAGE_DIR=/data -o yaml - + # Update all containers in all replication controllers in the project to have ENV=prod oc env rc --all ENV=prod - + # Import environment from a secret oc env --from=secret/mysecret dc/myapp - + # Import environment from a config map with a prefix oc env --from=configmap/myconfigmap --prefix=MYSQL_ dc/myapp - + # Remove the environment variable ENV from container 'c1' in all deployment configs oc env dc --all --containers="c1" ENV- - + # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server oc env -f dc.json ENV- - + # Set some of the local shell environment into a deployment config on the server env | grep RAILS_ | oc env -e - dc/registry ---- @@ -1643,7 +1605,7 @@ Perform a direct Docker build ---- # Build the current directory into a single layer and tag oc ex dockerbuild . myimage:latest - + # Mount a client secret into the build at a certain path oc ex dockerbuild . myimage:latest --mount ~/mysecret.pem:/etc/pki/secret/mysecret.pem ---- @@ -1659,7 +1621,7 @@ Execute a command in a container ---- # Get output from running 'date' in ruby-container from pod 'mypod' oc exec mypod -c ruby-container date - + # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 'mypod' and sends stdout/stderr from 'bash' back to the client oc exec mypod -c ruby-container -i -t -- bash -il ---- @@ -1673,11 +1635,11 @@ Documentation of resources [options="nowrap"] ---- -# Get the documentation of the resource and its fields -oc explain pods - -# Get the documentation of a specific field of a resource -oc explain pods.spec.containers + # Get the documentation of the resource and its fields + oc explain pods + + # Get the documentation of a specific field of a resource + oc explain pods.spec.containers ---- ==== @@ -1691,10 +1653,10 @@ Export resources so they can be used elsewhere ---- # export the services and deployment configurations labeled name=test oc export svc,dc -l name=test - + # export all services to a template oc export service --as-template=test - + # export to JSON oc export service -o json ---- @@ -1710,16 +1672,16 @@ Expose a replicated application as a service or route ---- # Create a route based on service nginx. The new route will re-use nginx's labels oc expose service nginx - + # Create a route and specify your own label and route name oc expose service nginx -l name=myroute --name=fromdowntown - + # Create a route and specify a hostname oc expose service nginx --hostname=www.example.com - + # Expose a deployment configuration as a service and use the specified port oc expose dc ruby-hello-world --port=8080 - + # Expose a service as a route in the specified path oc expose service nginx --path=/nginx ---- @@ -1735,10 +1697,10 @@ Extract secrets or config maps to disk ---- # extract the secret "test" to the current directory oc extract secret/test - + # extract the config map "nginx" to the /tmp directory oc extract configmap/nginx --to=/tmp - + # extract only the key "nginx.conf" from config map "nginx" to the /tmp directory oc extract configmap/nginx --to=/tmp --keys=nginx.conf ---- @@ -1754,16 +1716,16 @@ Display one or many resources ---- # List all pods in ps output format. oc get pods - + # List a single replication controller with specified ID in ps output format. oc get rc redis - + # List all pods and show more details about them. oc get -o wide pods - + # List a single pod in JSON output format. oc get -o json pod redis-pod - + # Return only the status value of the specified pod. oc get -o template pod redis-pod --template={{.currentState.status}} ---- @@ -1792,10 +1754,9 @@ Import an app.json definition into OpenShift (experimental) ---- # Import a directory containing an app.json file $ oc import app.json -f . - + # Turn an app.json file into a template $ oc import app.json -f ./app.json -o yaml --as-template - ---- ==== @@ -1809,10 +1770,9 @@ Import a docker-compose.yml project into OpenShift (experimental) ---- # Import a docker-compose.yml file into OpenShift oc import docker-compose -f ./docker-compose.yml - - # Turn a docker-compose.yml file into a template + + # Turn a docker-compose.yml file into a template oc import docker-compose -f ./docker-compose.yml -o yaml --as-template - ---- ==== @@ -1838,16 +1798,16 @@ Update the labels on a resource ---- # Update pod 'foo' with the label 'unhealthy' and the value 'true'. oc label pods foo unhealthy=true - + # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. oc label --overwrite pods foo status=unhealthy - + # Update all pods in the namespace oc label pods --all status=unhealthy - + # Update pod 'foo' only if the resource is unchanged from version 1. oc label pods foo status=unhealthy --resource-version=1 - + # Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the --overwrite flag. oc label pods foo bar- @@ -1864,10 +1824,10 @@ Log in to a server ---- # Log in interactively oc login - + # Log in to the given server with the given certificate authority file oc login localhost:8443 --certificate-authority=/path/to/cert.crt - + # Log in to the given server with the given credentials (will not prompt interactively) oc login localhost:8443 --username=myuser --password=mypass ---- @@ -1881,7 +1841,6 @@ End the current server session [options="nowrap"] ---- - # Logout oc logout ---- @@ -1897,18 +1856,18 @@ Print the logs for a resource. ---- # Start streaming the logs of the most recent build of the openldap build config. oc logs -f bc/openldap - + # Start streaming the logs of the latest deployment of the mysql deployment config. oc logs -f dc/mysql - + # Get the logs of the first deployment for the mysql deployment config. Note that logs # from older deployments may not exist either because the deployment was successful # or due to deployment pruning or manual deletion of the deployment. oc logs --version=1 dc/mysql - + # Return a snapshot of ruby-container logs from pod backend. oc logs backend -c ruby-container - + # Start streaming of ruby-container logs from pod backend. oc logs -f pod/backend -c ruby-container ---- @@ -1922,42 +1881,41 @@ Create a new application [options="nowrap"] ---- - # List all local templates and image streams that can be used to create an app oc new-app --list - + # Create an application based on the source code in the current git repository (with a public remote) # and a Docker image oc new-app . --docker-image=repo/langimage - + # Create a Ruby application based on the provided [image]~[source code] combination oc new-app centos/ruby-22-centos7~https://github.com/openshift/ruby-ex.git - + # Use the public Docker Hub MySQL image to create an app. Generated artifacts will be labeled with db=mysql oc new-app mysql MYSQL_USER=user MYSQL_PASSWORD=pass MYSQL_DATABASE=testdb -l db=mysql - + # Use a MySQL image in a private registry to create an app and override application artifacts' names oc new-app --docker-image=myregistry.com/mycompany/mysql --name=private - + # Create an application from a remote repository using its beta4 branch oc new-app https://github.com/openshift/ruby-hello-world#beta4 - + # Create an application based on a stored template, explicitly setting a parameter value oc new-app --template=ruby-helloworld-sample --param=MYSQL_USER=admin - + # Create an application from a remote repository and specify a context directory oc new-app https://github.com/youruser/yourgitrepo --context-dir=src/build - + # Create an application based on a template file, explicitly setting a parameter value oc new-app --file=./example/myapp/template.json --param=MYSQL_USER=admin - + # Search all templates, image streams, and Docker images for the ones that match "ruby" oc new-app --search ruby - + # Search for "ruby", but only in stored templates (--template, --image-stream and --docker-image # can be used to filter search results) oc new-app --search --template=ruby - + # Search for "ruby" in stored templates and print the output as an YAML oc new-app --search --template=ruby --output=yaml ---- @@ -1971,26 +1929,25 @@ Create a new build configuration [options="nowrap"] ---- - # Create a build config based on the source code in the current git repository (with a public # remote) and a Docker image oc new-build . --docker-image=repo/langimage - + # Create a NodeJS build config based on the provided [image]~[source code] combination oc new-build openshift/nodejs-010-centos7~https://github.com/openshift/nodejs-ex.git - + # Create a build config from a remote repository using its beta2 branch oc new-build https://github.com/openshift/ruby-hello-world#beta2 - + # Create a build config using a Dockerfile specified as an argument oc new-build -D $'FROM centos:7\nRUN yum install -y httpd' - + # Create a build config from a remote repository and add custom environment variables oc new-build https://github.com/openshift/ruby-hello-world RACK_ENV=development - + # Create a build config from a remote repository and inject the npmrc into a build oc new-build https://github.com/openshift/ruby-hello-world --build-secret npmrc:.npmrc - + # Create a build config that gets its input from a remote repository and another Docker image oc new-build https://github.com/openshift/ruby-hello-world --source-image=openshift/jenkins-1-centos7 --source-image-path=/var/lib/jenkins:tmp ---- @@ -2006,7 +1963,7 @@ Request a new project ---- # Create a new project with minimal information oc new-project web-team-dev - + # Create a new project with a display name and description oc new-project web-team-dev --display-name="Web Team Development" --description="Development project for the web team." ---- @@ -2020,12 +1977,11 @@ Observe changes to resources and react to them (experimental) [options="nowrap"] ---- - # observe changes to services - oc observe services - - # observe changes to services, including the clusterIP and invoke a script for each - oc observe services -a '{ .spec.clusterIP }' -- register_dns.sh - + # Observe changes to services + oc observe services + + # Observe changes to services, including the clusterIP and invoke a script for each + oc observe services -a '{ .spec.clusterIP }' -- register_dns.sh ---- ==== @@ -2052,7 +2008,7 @@ Add a role to users or serviceaccounts for the current project ---- # Add the 'view' role to user1 for the current project oc policy add-role-to-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project oc policy add-role-to-user edit -z serviceaccount1 ---- @@ -2068,13 +2024,13 @@ Forward one or more local ports to a pod ---- # Listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod oc port-forward mypod 5000 6000 - + # Listens on port 8888 locally, forwarding to 5000 in the pod oc port-forward mypod 8888:5000 - + # Listens on a random port locally, forwarding to 5000 in the pod oc port-forward mypod :5000 - + # Listens on a random port locally, forwarding to 5000 in the pod oc port-forward mypod 0:5000 ---- @@ -2090,19 +2046,19 @@ Process a template into list of resources ---- # Convert template.json file into resource list and pass to create oc process -f template.json | oc create -f - - + # Process template while passing a user-defined label oc process -f template.json -l name=mytemplate - + # Convert stored template into resource list oc process foo - + # Convert stored template into resource list by setting/overriding parameter values oc process foo PARM1=VALUE1 PARM2=VALUE2 - + # Convert template stored in different namespace into a resource list oc process openshift//foo - + # Convert template.json into resource list cat template.json | oc process -f - ---- @@ -2118,7 +2074,7 @@ Switch to another project ---- # Switch to 'myapp' project oc project myapp - + # Display the project currently in use oc project ---- @@ -2134,11 +2090,11 @@ Run a proxy to the Kubernetes API server ---- # Run a proxy to the api server on port 8011, serving static content from ./local/www/ oc proxy --port=8011 --www=./local/www/ - + # Run a proxy to the api server on an arbitrary local port. # The chosen port for the server will be output to stdout. oc proxy --port=0 - + # Run a proxy to the api server, changing the api prefix to my-api # This makes e.g. the pods api available at localhost:8011/my-api/api/v1/pods/ oc proxy --api-prefix=/my-api @@ -2155,10 +2111,10 @@ Replace a resource by filename or stdin ---- # Replace a pod using the data in pod.json. oc replace -f pod.json - + # Replace a pod based on the JSON passed into stdin. cat pod.json | oc replace -f - - + # Force replace, delete and then re-create the resource oc replace --force -f pod.json ---- @@ -2174,13 +2130,13 @@ Revert part of an application back to a previous deployment ---- # Perform a rollback to the last successfully completed deployment for a deploymentconfig oc rollback frontend - + # See what a rollback to version 3 will look like, but don't perform the rollback oc rollback frontend --to-version=3 --dry-run - + # Perform a rollback to a specific deployment oc rollback frontend-2 - + # Perform the rollback manually by piping the JSON of the new config back to oc oc rollback frontend -o json | oc replace dc/frontend -f - ---- @@ -2196,7 +2152,7 @@ View rollout history ---- # View the rollout history of a deployment oc rollout history dc/nginx - + # View the details of deployment revision 3 oc rollout history dc/nginx --revision=3 ---- @@ -2240,7 +2196,7 @@ Undo a previous rollout ---- # Rollback to the previous deployment oc rollout undo dc/nginx - + # Rollback to deployment revision 3. The replication controller for that version must exist. oc rollout undo dc/nginx --to-revision=3 ---- @@ -2254,16 +2210,15 @@ Start a shell session in a pod [options="nowrap"] ---- - # Open a shell session on the first container in pod 'foo' oc rsh foo - + # Run the command 'cat /etc/resolv.conf' inside pod 'foo' oc rsh foo cat /etc/resolv.conf - + # See the configuration of your internal registry oc rsh dc/docker-registry cat config.yml - + # Open a shell session on the container named 'index' inside a pod of your job # oc rsh -c index job/sheduled ---- @@ -2277,10 +2232,9 @@ Copy files between local filesystem and a pod [options="nowrap"] ---- - # Synchronize a local directory with a pod directory oc rsync ./local/dir/ POD:/remote/dir - + # Synchronize a pod directory with a local directory oc rsync POD:/remote/dir/ ./local/dir ---- @@ -2296,17 +2250,17 @@ Run a particular image on the cluster ---- # Starts a single instance of nginx. oc run nginx --image=nginx - + # Starts a replicated instance of nginx. oc run nginx --image=nginx --replicas=5 - + # Dry run. Print the corresponding API objects without creating them. oc run nginx --image=nginx --dry-run - + # Start a single instance of nginx, but overload the spec of the replication # controller with a partial set of values parsed from JSON. oc run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }' - + # Start a single instance of nginx and keep it in the foreground, don't restart it if it exits. oc run -i --tty nginx --image=nginx --restart=Never ---- @@ -2322,10 +2276,10 @@ Change the number of pods in a deployment ---- # Scale replication controller named 'foo' to 3. oc scale --replicas=3 replicationcontrollers foo - + # If the replication controller named foo's current size is 2, scale foo to 3. oc scale --current-replicas=2 --replicas=3 replicationcontrollers foo - + # Scale the latest deployment of 'bar'. In case of no deployment, bar's template # will be scaled instead. oc scale --replicas=10 dc bar @@ -2342,10 +2296,10 @@ DEPRECATED: secrets link ---- # Add an image pull secret to a service account to automatically use it for pulling pod images: oc serviceaccount-name pull-secret --for=pull - + # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images: oc builder builder-image-secret --for=pull,mount - + # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod: oc pod-sa pod-secret ---- @@ -2361,10 +2315,10 @@ Link secrets to a ServiceAccount ---- # Add an image pull secret to a service account to automatically use it for pulling pod images: oc secrets link serviceaccount-name pull-secret --for=pull - + # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images: oc secrets link builder builder-image-secret --for=pull,mount - + # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod: oc secrets link pod-sa pod-secret ---- @@ -2380,16 +2334,16 @@ Create a new secret based on a key file or on files within a directory ---- # Create a new secret named my-secret with a key named ssh-privatekey oc secrets new my-secret ~/.ssh/ssh-privatekey - + # Create a new secret named my-secret with keys named ssh-privatekey and ssh-publickey instead of the names of the keys on disk oc secrets new my-secret ssh-privatekey=~/.ssh/id_rsa ssh-publickey=~/.ssh/id_rsa.pub - + # Create a new secret named my-secret with keys for each file in the folder "bar" oc secrets new my-secret path/to/bar - + # Create a new .dockercfg secret named my-secret oc secrets new my-secret path/to/.dockercfg - + # Create a new .docker/config.json secret named my-secret oc secrets new my-secret .dockerconfigjson=path/to/.docker/config.json ---- @@ -2403,13 +2357,13 @@ Create a new secret for basic authentication [options="nowrap"] ---- - // If your basic authentication method requires only username and password or token, add it by using: + # If your basic authentication method requires only username and password or token, add it by using: oc secrets new-basicauth SECRET --username=USERNAME --password=PASSWORD - - // If your basic authentication method requires also CA certificate, add it by using: + + # If your basic authentication method requires also CA certificate, add it by using: oc secrets new-basicauth SECRET --username=USERNAME --password=PASSWORD --ca-cert=FILENAME - - // If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: + + # If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: oc secrets new SECRET path/to/.gitconfig ---- ==== @@ -2424,13 +2378,13 @@ Create a new dockercfg secret ---- # Create a new .dockercfg secret: oc secrets new-dockercfg SECRET --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL - + # Create a new .dockercfg secret from an existing file: oc secrets new SECRET path/to/.dockercfg - + # Create a new .docker/config.json secret from an existing file: oc secrets new SECRET .dockerconfigjson=path/to/.docker/config.json - + # To add new secret to 'imagePullSecrets' for the node, or 'secrets' for builds, use: oc edit SERVICE_ACCOUNT ---- @@ -2444,13 +2398,13 @@ Create a new secret for SSH authentication [options="nowrap"] ---- - // If your SSH authentication method requires only private SSH key, add it by using: + # If your SSH authentication method requires only private SSH key, add it by using: oc secrets new-sshauth SECRET --ssh-privatekey=FILENAME - - // If your SSH authentication method requires also CA certificate, add it by using: + + # If your SSH authentication method requires also CA certificate, add it by using: oc secrets new-sshauth SECRET --ssh-privatekey=FILENAME --ca-cert=FILENAME - - // If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: + + # If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: oc secrets new SECRET path/to/.gitconfig ---- ==== @@ -2463,8 +2417,8 @@ Detach secrets from a ServiceAccount [options="nowrap"] ---- - # Unlink a secret currently associated with a service account: -oc secrets unlink serviceaccount-name secret-name another-secret-name ... + # Unlink a secret currently associated with a service account: + oc secrets unlink serviceaccount-name secret-name another-secret-name ... ---- ==== @@ -2478,7 +2432,6 @@ Get a token assigned to a service account. ---- # Get the service account token from service account 'default' oc serviceaccounts get-token 'default' - ---- ==== @@ -2492,11 +2445,10 @@ Generate a new token for a service account. ---- # Generate a new token for service account 'default' oc serviceaccounts new-token 'default' - + # Generate a new token for service account 'default' and apply # labels 'foo' and 'bar' to the new token for identification # oc serviceaccounts new-token 'default' --labels foo=foo-value,bar=bar-value - ---- ==== @@ -2510,13 +2462,13 @@ Update a build hook on a build config ---- # Clear post-commit hook on a build config oc set build-hook bc/mybuild --post-commit --remove - + # Set the post-commit hook to execute a test suite using a new entrypoint oc set build-hook bc/mybuild --post-commit --command -- /bin/bash -c /var/lib/test-image.sh - + # Set the post-commit hook to execute a shell script oc set build-hook bc/mybuild --post-commit --script="/var/lib/test-image.sh param1 param2 && /var/lib/done.sh" - + # Set the post-commit hook as a set of arguments to the default image entrypoint oc set build-hook bc/mybuild --post-commit -- arg1 arg2 ---- @@ -2532,11 +2484,11 @@ Update a deployment hook on a deployment config ---- # Clear pre and post hooks on a deployment config oc set deployment-hook dc/myapp --remove --pre --post - + # Set the pre deployment hook to execute a db migration command for an application # using the data volume from the application oc set deployment-hook dc/myapp --pre -v data -- /var/lib/migrate-db.sh - + # Set a mid deployment hook along with additional environment variables oc set deployment-hook dc/myapp --mid -v data -e VAR1=value1 -e VAR2=value2 -- /var/lib/prepare-deploy.sh ---- @@ -2552,32 +2504,32 @@ Update environment variables on a pod template ---- # Update deployment 'registry' with a new environment variable oc set env dc/registry STORAGE_DIR=/local - + # List the environment variables defined on a build config 'sample-build' oc set env bc/sample-build --list - + # List the environment variables defined on all pods oc set env pods --all --list - + # Output modified build config in YAML, and does not alter the object on the server oc set env bc/sample-build STORAGE_DIR=/data -o yaml - + # Update all containers in all replication controllers in the project to have ENV=prod oc set env rc --all ENV=prod - + # Import environment from a secret oc set env --from=secret/mysecret dc/myapp - + # Import environment from a config map with a prefix oc set env --from=configmap/myconfigmap --prefix=MYSQL_ dc/myapp - + # Remove the environment variable ENV from container 'c1' in all deployment configs oc set env dc --all --containers="c1" ENV- - + # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server oc set env -f dc.json ENV- - + # Set some of the local shell environment into a deployment config on the server env | grep RAILS_ | oc set env -e - dc/registry ---- @@ -2593,13 +2545,13 @@ Update image of a pod template ---- # Set a deployment configs's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. oc set image dc/nginx busybox=busybox nginx=nginx:1.9.1 - + # Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' oc set image deployments,rc nginx=nginx:1.9.1 --all - + # Update image of all containers of daemonset abc to 'nginx:1.9.1' oc set image daemonset abc *=nginx:1.9.1 - + # Print result (in yaml format) of updating nginx container image from local file, without hitting the server oc set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml ---- @@ -2615,19 +2567,19 @@ Update a probe on a pod template ---- # Clear both readiness and liveness probes off all containers oc set probe dc/registry --remove --readiness --liveness - + # Set an exec action as a liveness probe to run 'echo ok' oc set probe dc/registry --liveness -- echo ok - + # Set a readiness probe to try to open a TCP socket on 3306 oc set probe rc/mysql --readiness --open-tcp=3306 - + # Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP oc set probe dc/webapp --readiness --get-url=http://:8080/healthz - + # Set an HTTP readiness probe over HTTPS on 127.0.0.1 for a hostNetwork pod oc set probe dc/router --readiness --get-url=https://127.0.0.1:1936/stats - + # Set only the initial-delay-seconds field on all deployments oc set probe dc --all --readiness --initial-delay-seconds=30 ---- @@ -2643,19 +2595,19 @@ Update the backends for a route ---- # Print the backends on the route 'web' oc set route-backends web - + # Set two backend services on route 'web' with 2/3rds of traffic going to 'a' oc set route-backends web a=2 b=1 - + # Increase the traffic percentage going to b by 10% relative to a oc set route-backends web --adjust b=+10% - + # Set traffic percentage going to b to 10% of the traffic going to a oc set route-backends web --adjust b=10% - + # Set weight of b to 10 oc set route-backends web --adjust b=10 - + # Set the weight to all backends to zero oc set route-backends web --zero ---- @@ -2671,23 +2623,23 @@ Update the triggers on a build or deployment config ---- # Print the triggers on the registry oc set triggers dc/registry - + # Set all triggers to manual oc set triggers dc/registry --manual - + # Enable all automatic triggers oc set triggers dc/registry --auto - + # Reset the GitHub webhook on a build to a new, generated secret oc set triggers bc/webapp --from-github oc set triggers bc/webapp --from-webhook - + # Remove all triggers oc set triggers bc/webapp --remove-all - + # Stop triggering on config change oc set triggers dc/registry --from-config --remove - + # Add an image trigger to a build config oc set triggers bc/webapp --from-image=namespace1/image:latest ---- @@ -2703,27 +2655,27 @@ Update volumes on a pod template ---- # List volumes defined on all deployment configs in the current project oc set volume dc --all - + # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry oc set volume dc/registry --add --mount-path=/var/lib/registry - + # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' oc set volume dc/registry --add --name=v1 -t pvc --claim-name=pvc1 --overwrite - + # Remove volume 'v1' from deployment config 'registry' oc set volume dc/registry --remove --name=v1 - + # Create a new persistent volume claim that overwrites an existing volume 'v1' oc set volume dc/registry --add --name=v1 -t pvc --claim-size=1G --overwrite - + # Change the mount point for volume 'v1' to /data oc set volume dc/registry --add --name=v1 -m /data --overwrite - + # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) oc set volume dc/registry --remove --name=v1 --containers=c1 - + # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) oc set volume dc/registry --add -m /repo --source= @@ -2740,20 +2692,20 @@ Start a new build ---- # Starts build from build config "hello-world" oc start-build hello-world - + # Starts build from a previous build "hello-world-1" oc start-build --from-build=hello-world-1 - + # Use the contents of a directory as build input oc start-build hello-world --from-dir=src/ - + # Send the contents of a Git repository to the server from tag 'v2' oc start-build hello-world --from-repo=../hello-world --commit=v2 - + # Start a new build for build config "hello-world" and watch the logs until the build # completes or fails. oc start-build hello-world --follow - + # Start a new build for build config "hello-world" and wait until the build completes. It # exits with a non-zero return code if the build fails. oc start-build hello-world --wait @@ -2770,10 +2722,10 @@ Show an overview of the current project ---- # See an overview of the current project. oc status - + # Export the overview of the current project in an svg file. oc status -o dot | dot -T svg -o project.svg - + # See an overview of the current project including details for any identified issues. oc status -v ---- @@ -2789,13 +2741,13 @@ Tag existing images into image streams ---- # Tag the current image for the image stream 'openshift/ruby' and tag '2.0' into the image stream 'yourproject/ruby with tag 'tip'. oc tag openshift/ruby:2.0 yourproject/ruby:tip - + # Tag a specific image. oc tag openshift/ruby@sha256:6b646fa6bf5e5e4c7fa41056c27910e679c03ebe7f93e361e6515a9da7e258cc yourproject/ruby:tip - + # Tag an external Docker image. oc tag --source=docker openshift/origin:latest yourproject/ruby:tip - + # Remove the specified spec tag from an image stream. oc tag openshift/origin:latest -d ---- @@ -2811,13 +2763,13 @@ An introduction to concepts and types ---- # View all projects you have access to oc get projects - + # See a list of all services in the current project oc get svc - + # Describe a deployment configuration in detail oc describe dc mydeploymentconfig - + # Show the images tagged into an image stream oc describe is ruby-centos7 ---- @@ -2833,27 +2785,27 @@ DEPRECATED: set volume ---- # List volumes defined on all deployment configs in the current project oc volume dc --all - + # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry oc volume dc/registry --add --mount-path=/var/lib/registry - + # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' oc volume dc/registry --add --name=v1 -t pvc --claim-name=pvc1 --overwrite - + # Remove volume 'v1' from deployment config 'registry' oc volume dc/registry --remove --name=v1 - + # Create a new persistent volume claim that overwrites an existing volume 'v1' oc volume dc/registry --add --name=v1 -t pvc --claim-size=1G --overwrite - + # Change the mount point for volume 'v1' to /data oc volume dc/registry --add --name=v1 -m /data --overwrite - + # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) oc volume dc/registry --remove --name=v1 --containers=c1 - + # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) oc volume dc/registry --add -m /repo --source= diff --git a/docs/man/man1/oadm-build-chain.1 b/docs/man/man1/oadm-build-chain.1 index 146e50c7ed05..139aed00d64e 100644 --- a/docs/man/man1/oadm-build-chain.1 +++ b/docs/man/man1/oadm-build-chain.1 @@ -16,9 +16,7 @@ oadm build\-chain \- Output the inputs and dependencies of your builds Output the inputs and dependencies of your builds .PP -Supported formats for the generated graph are dot and a human\-readable output. -Tag and namespace are optional and if they are not specified, 'latest' and the -default namespace will be used respectively. +Supported formats for the generated graph are dot and a human\-readable output.Tag and namespace are optional and if they are not specified, 'latest' and thedefault namespace will be used respectively. .SH OPTIONS @@ -112,10 +110,10 @@ default namespace will be used respectively. .nf # Build the dependency tree for the 'latest' tag in oadm build\-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility oadm build\-chain :v2 \-o dot | dot \-T svg \-o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace oadm build\-chain \-n test \-\-all diff --git a/docs/man/man1/oadm-ca-create-key-pair.1 b/docs/man/man1/oadm-ca-create-key-pair.1 index 4679f3810b38..0c897bd3d29b 100644 --- a/docs/man/man1/oadm-ca-create-key-pair.1 +++ b/docs/man/man1/oadm-ca-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -oadm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + oadm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/oadm-ca-create-master-certs.1 b/docs/man/man1/oadm-ca-create-master-certs.1 index e67c666b3ecd..84e30357db65 100644 --- a/docs/man/man1/oadm-ca-create-master-certs.1 +++ b/docs/man/man1/oadm-ca-create-master-certs.1 @@ -16,66 +16,39 @@ oadm ca create\-master\-certs \- Create certificates and keys for a master Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -oadm ca create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + oadm ca create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/oadm-ca-create-server-cert.1 b/docs/man/man1/oadm-ca-create-server-cert.1 index 69fb921ff486..8df67548460e 100644 --- a/docs/man/man1/oadm-ca-create-server-cert.1 +++ b/docs/man/man1/oadm-ca-create-server-cert.1 @@ -16,26 +16,18 @@ oadm ca create\-server\-cert \- Create a signed server certificate and key Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -oadm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + oadm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/oadm-ca-decrypt.1 b/docs/man/man1/oadm-ca-decrypt.1 index 327aede17fff..657b49bcb6cf 100644 --- a/docs/man/man1/oadm-ca-decrypt.1 +++ b/docs/man/man1/oadm-ca-decrypt.1 @@ -101,12 +101,11 @@ Decrypt data encrypted with "oadm ca encrypt" .RS .nf - # Decrypt an encrypted file to a cleartext file: - oadm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - - # Decrypt from stdin to stdout: - oadm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted - + # Decrypt an encrypted file to a cleartext file: + oadm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted + + # Decrypt from stdin to stdout: + oadm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted .fi .RE diff --git a/docs/man/man1/oadm-ca-encrypt.1 b/docs/man/man1/oadm-ca-encrypt.1 index 306208734959..89f12780e744 100644 --- a/docs/man/man1/oadm-ca-encrypt.1 +++ b/docs/man/man1/oadm-ca-encrypt.1 @@ -105,12 +105,11 @@ Encrypt data with AES\-256\-CBC encryption .RS .nf - # Encrypt the content of secret.txt with a generated key: - oadm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - - # Encrypt the content of secret2.txt with an existing key: - oadm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted - + # Encrypt the content of secret.txt with a generated key: + oadm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted + + # Encrypt the content of secret2.txt with an existing key: + oadm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted .fi .RE diff --git a/docs/man/man1/oadm-completion.1 b/docs/man/man1/oadm-completion.1 index 16106186e3b9..8aee4a17bc0a 100644 --- a/docs/man/man1/oadm-completion.1 +++ b/docs/man/man1/oadm-completion.1 @@ -13,8 +13,7 @@ oadm completion \- Output shell completion code for the given shell (bash or zsh .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of oadm commands. +This command prints shell code which must be evaluated to provide interactivecompletion of oadm commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -91,18 +90,19 @@ completion of oadm commands. # Generate the oadm completion code for bash oadm completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion oadm completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(oadm completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/oadm-config-current-context.1 b/docs/man/man1/oadm-config-current-context.1 index f2523047c252..641051340d8f 100644 --- a/docs/man/man1/oadm-config-current-context.1 +++ b/docs/man/man1/oadm-config-current-context.1 @@ -87,7 +87,6 @@ Displays the current\-context .RS .nf - # Display the current\-context oadm config current\-context diff --git a/docs/man/man1/oadm-config-set-cluster.1 b/docs/man/man1/oadm-config-set-cluster.1 index 4d5c404508cb..715786da2b8c 100644 --- a/docs/man/man1/oadm-config-set-cluster.1 +++ b/docs/man/man1/oadm-config-set-cluster.1 @@ -13,8 +13,7 @@ oadm config set\-cluster \- Sets a cluster entry in kubeconfig .SH DESCRIPTION .PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set only the server field on the e2e cluster entry without touching other values. oadm config set\-cluster e2e \-\-server=https://1.2.3.4 diff --git a/docs/man/man1/oadm-config-set-context.1 b/docs/man/man1/oadm-config-set-context.1 index eb2ad7d4338a..ff395816067a 100644 --- a/docs/man/man1/oadm-config-set-context.1 +++ b/docs/man/man1/oadm-config-set-context.1 @@ -13,8 +13,7 @@ oadm config set\-context \- Sets a context entry in kubeconfig .SH DESCRIPTION .PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set the user field on the gce context entry without touching other values oadm config set\-context gce \-\-user=cluster\-admin diff --git a/docs/man/man1/oadm-config-set-credentials.1 b/docs/man/man1/oadm-config-set-credentials.1 index cd82635b0f99..7407da4aaa1f 100644 --- a/docs/man/man1/oadm-config-set-credentials.1 +++ b/docs/man/man1/oadm-config-set-credentials.1 @@ -13,20 +13,16 @@ oadm config set\-credentials \- Sets a user entry in kubeconfig .SH DESCRIPTION .PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. +Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values. .PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile +Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile .PP -Bearer token flags: - \-\-token=bearer\_token +Bearer token flags:\-\-token=bearer\_token .PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password +Basic auth flags:\-\-username=basicuser \-\-password=basicpassword .PP Bearer token and basic auth are mutually exclusive. @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive. .RS .nf - # Set only the "client\-key" field on the "cluster\-admin" # entry, without touching other values: oadm config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key diff --git a/docs/man/man1/oadm-config-set.1 b/docs/man/man1/oadm-config-set.1 index 0f9d03bc6a08..f600bdef3fa1 100644 --- a/docs/man/man1/oadm-config-set.1 +++ b/docs/man/man1/oadm-config-set.1 @@ -13,9 +13,7 @@ oadm config set \- Sets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. +Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. .SH OPTIONS diff --git a/docs/man/man1/oadm-config-unset.1 b/docs/man/man1/oadm-config-unset.1 index be8155d5a92c..65b308215fe7 100644 --- a/docs/man/man1/oadm-config-unset.1 +++ b/docs/man/man1/oadm-config-unset.1 @@ -13,8 +13,7 @@ oadm config unset \- Unsets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. +Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-config-view.1 b/docs/man/man1/oadm-config-view.1 index 29c63469c354..0923fa435345 100644 --- a/docs/man/man1/oadm-config-view.1 +++ b/docs/man/man1/oadm-config-view.1 @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat .RS .nf - # Show Merged kubeconfig settings. oadm config view diff --git a/docs/man/man1/oadm-config.1 b/docs/man/man1/oadm-config.1 index 8961b3d2779e..20c5898ee4b7 100644 --- a/docs/man/man1/oadm-config.1 +++ b/docs/man/man1/oadm-config.1 @@ -16,9 +16,7 @@ oadm config \- Change configuration files for the client Manage the client config files .PP -The client stores configuration in the current user's home directory (under the .kube directory as -config). When you login the first time, a new config file is created, and subsequent project changes with the -'project' command will set the current context. These subcommands allow you to manage the config directly. +The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly. .PP Reference: diff --git a/docs/man/man1/oadm-cordon.1 b/docs/man/man1/oadm-cordon.1 index 553f27249a59..44f21eab709f 100644 --- a/docs/man/man1/oadm-cordon.1 +++ b/docs/man/man1/oadm-cordon.1 @@ -87,10 +87,8 @@ Mark node as unschedulable. .RS .nf - -# Mark node "foo" as unschedulable. -oadm cordon foo - + # Mark node "foo" as unschedulable. + oadm cordon foo .fi .RE diff --git a/docs/man/man1/oadm-create-api-client-config.1 b/docs/man/man1/oadm-create-api-client-config.1 index 21378cebdec8..6b73c53e91c6 100644 --- a/docs/man/man1/oadm-create-api-client-config.1 +++ b/docs/man/man1/oadm-create-api-client-config.1 @@ -16,9 +16,7 @@ oadm create\-api\-client\-config \- Create a config file for connecting to the s Create a client configuration for connecting to the server .PP -This command creates a folder containing a client certificate, a client key, -a server certificate authority, and a .kubeconfig file for connecting to the -master as the provided user. +This command creates a folder containing a client certificate, a client key,a server certificate authority, and a .kubeconfig file for connecting to themaster as the provided user. .SH OPTIONS diff --git a/docs/man/man1/oadm-create-error-template.1 b/docs/man/man1/oadm-create-error-template.1 index 0215dd2f8630..145c1b84760d 100644 --- a/docs/man/man1/oadm-create-error-template.1 +++ b/docs/man/man1/oadm-create-error-template.1 @@ -16,24 +16,15 @@ oadm create\-error\-template \- Create an error page template Create a template for customizing the error page .PP -This command creates a basic template to use as a starting point for -customizing the authentication error page. Save the output to a file and edit -the template to change the look and feel or add content. +This command creates a basic template to use as a starting point forcustomizing the authentication error page. Save the output to a file and editthe template to change the look and feel or add content. .PP -To use the template, set oauthConfig.templates.error in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.error in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - error: templates/error.html - -.fi -.RE + templates: + error: templates/error.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-create-key-pair.1 b/docs/man/man1/oadm-create-key-pair.1 index d277e0b7f026..7d51c3e93280 100644 --- a/docs/man/man1/oadm-create-key-pair.1 +++ b/docs/man/man1/oadm-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -oadm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + oadm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/oadm-create-kubeconfig.1 b/docs/man/man1/oadm-create-kubeconfig.1 index 1459242d5645..3d32b00f8203 100644 --- a/docs/man/man1/oadm-create-kubeconfig.1 +++ b/docs/man/man1/oadm-create-kubeconfig.1 @@ -13,36 +13,36 @@ oadm create\-kubeconfig \- Create a basic .kubeconfig file from client certs .SH DESCRIPTION .PP -Create's a .kubeconfig file at <\-\-kubeconfig> that looks like this: +Create's a .kubeconfig file at<\-\-kubeconfig> that looks like this: .PP clusters: -\- cluster: - certificate\-authority\-data: - server: <\-\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-master> name: <\-\-cluster> -\- cluster: - certificate\-authority\-data: - server: <\-\-public\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-public\-master> name: public\-<\-\-cluster> -contexts: -\- context: - cluster: <\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + contexts: + \- context: + cluster: <\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: <\-\-context> -\- context: - cluster: public\-<\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + \- context: + cluster: public\-<\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: public\-<\-\-context> -current\-context: <\-\-context> -kind: Config -users: -\- name: <\-\-user> + current\-context: <\-\-context> + kind: Config + users: + \- name: <\-\-user> user: - client\-certificate\-data: - client\-key\-data: + client\-certificate\-data: + client\-key\-data: .SH OPTIONS diff --git a/docs/man/man1/oadm-create-login-template.1 b/docs/man/man1/oadm-create-login-template.1 index a3ec3113859c..d46babcb3b03 100644 --- a/docs/man/man1/oadm-create-login-template.1 +++ b/docs/man/man1/oadm-create-login-template.1 @@ -16,25 +16,15 @@ oadm create\-login\-template \- Create a login template Create a template for customizing the login page .PP -This command creates a basic template to use as a starting point for -customizing the login page. Save the output to a file and edit the template to -change the look and feel or add content. Be careful not to remove any parameter -values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login page. Save the output to a file and edit the template tochange the look and feel or add content. Be careful not to remove any parametervalues inside curly braces. .PP -To use the template, set oauthConfig.templates.login in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.login in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - login: templates/login.html - -.fi -.RE + templates: + login: templates/login.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-create-master-certs.1 b/docs/man/man1/oadm-create-master-certs.1 index 8a80d646172c..b1e04ba3d73b 100644 --- a/docs/man/man1/oadm-create-master-certs.1 +++ b/docs/man/man1/oadm-create-master-certs.1 @@ -16,66 +16,39 @@ oadm create\-master\-certs \- Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -oadm create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + oadm create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/oadm-create-provider-selection-template.1 b/docs/man/man1/oadm-create-provider-selection-template.1 index 964fb79ea874..a11f9247c5d0 100644 --- a/docs/man/man1/oadm-create-provider-selection-template.1 +++ b/docs/man/man1/oadm-create-provider-selection-template.1 @@ -16,25 +16,15 @@ oadm create\-provider\-selection\-template \- Create a provider selection templa Create a template for customizing the provider selection page .PP -This command creates a basic template to use as a starting point for -customizing the login provider selection page. Save the output to a file and edit -the template to change the look and feel or add content. Be careful not to remove -any parameter values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login provider selection page. Save the output to a file and editthe template to change the look and feel or add content. Be careful not to removeany parameter values inside curly braces. .PP -To use the template, set oauthConfig.templates.providerSelection in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.providerSelection in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - providerSelection: templates/provider\-selection.html - -.fi -.RE + templates: + providerSelection: templates/provider\-selection.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-create-server-cert.1 b/docs/man/man1/oadm-create-server-cert.1 index ee6a34b64047..8c48e26afca2 100644 --- a/docs/man/man1/oadm-create-server-cert.1 +++ b/docs/man/man1/oadm-create-server-cert.1 @@ -16,26 +16,18 @@ oadm create\-server\-cert \- Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -oadm create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + oadm create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/oadm-diagnostics.1 b/docs/man/man1/oadm-diagnostics.1 index fdd29d530a11..45d2ad45262c 100644 --- a/docs/man/man1/oadm-diagnostics.1 +++ b/docs/man/man1/oadm-diagnostics.1 @@ -13,59 +13,32 @@ oadm diagnostics \- Diagnose common cluster problems .SH DESCRIPTION .PP -This utility helps troubleshoot and diagnose known problems. It runs -diagnostics using a client and/or the state of a running master / -node host. +This utility helps troubleshoot and diagnose known problems. It runsdiagnostics using a client and/or the state of a running master /node host. .PP -.RS - -.nf oadm diagnostics -.fi -.RE - .PP -If run without flags, it will check for standard config files for -client, master, and node, and if found, use them for diagnostics. -You may also specify config files explicitly with flags, in which case -you will receive an error if they are not found. For example: +If run without flags, it will check for standard config files forclient, master, and node, and if found, use them for diagnostics.You may also specify config files explicitly with flags, in which caseyou will receive an error if they are not found. For example: .PP -.RS - -.nf oadm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml - -.fi -.RE .IP .IP -\(bu If master/node config files are not found and the \-\-host flag is not -present, host diagnostics are skipped. +\(bu If master/node config files are not found and the \-\-host flag is notpresent, host diagnostics are skipped. .IP -\(bu If the client has cluster\-admin access, this access enables cluster -diagnostics to run which regular users cannot. +\(bu If the client has cluster\-admin access, this access enables clusterdiagnostics to run which regular users cannot. .IP -\(bu If a client config file is not found, client and cluster diagnostics -are skipped. +\(bu If a client config file is not found, client and cluster diagnosticsare skipped. .PP Diagnostics may be individually run by passing diagnostic name as arguments. .PP -.RS - -.nf oadm diagnostics -.fi -.RE - .PP -The available diagnostic names are: -AggregatedLogging AnalyzeLogs ClusterRegistry ClusterRoleBindings ClusterRoles ClusterRouter ConfigContexts DiagnosticPod MasterConfigCheck MasterNode MetricsApiProxy NodeConfigCheck NodeDefinitions ServiceExternalIPs UnitStatus +The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegistry, ClusterRoleBindings, ClusterRoles, ClusterRouter, ConfigContexts, DiagnosticPod, MasterConfigCheck, MasterNode, MetricsApiProxy, NodeConfigCheck, NodeDefinitions, ServiceExternalIPs, UnitStatus. .SH OPTIONS diff --git a/docs/man/man1/oadm-drain.1 b/docs/man/man1/oadm-drain.1 index ca32f92264b3..67e2cb0be144 100644 --- a/docs/man/man1/oadm-drain.1 +++ b/docs/man/man1/oadm-drain.1 @@ -16,22 +16,14 @@ oadm drain \- Drain node in preparation for maintenance Drain node in preparation for maintenance. .PP -The given node will be marked unschedulable to prevent new pods from arriving. -Then drain deletes all pods except mirror pods (which cannot be deleted through -the API server). If there are DaemonSet\-managed pods, drain will not proceed -without \-\-ignore\-daemonsets, and regardless it will not delete any -DaemonSet\-managed pods, because those pods would be immediately replaced by the -DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed\-\-by ReplicationController, -ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless you -use \-\-force. +The given node will be marked unschedulable to prevent new pods from arriving.Then drain deletes all pods except mirror pods (which cannot be deleted throughthe API server). If there are DaemonSet\-managed pods, drain will not proceedwithout \-\-ignore\-daemonsets, and regardless it will not delete anyDaemonSet\-managed pods, because those pods would be immediately replaced by theDaemonSet controller, which ignores unschedulable markings. If there are anypods that are neither mirror pods nor managed\-\-by ReplicationController,ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless youuse \-\-force. .PP -When you are ready to put the node back into service, use kubectl uncordon, which -will make the node schedulable again. +When you are ready to put the node back into service, use kubectl uncordon, whichwill make the node schedulable again. .PP +\[la]http://kubernetes.io/images/docs/kubectl_drain.svg\[ra] .SH OPTIONS @@ -123,13 +115,11 @@ will make the node schedulable again. .RS .nf - -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ oadm drain foo \-\-force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ oadm drain foo \-\-grace\-period=900 - + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. + $ oadm drain foo \-\-force + + # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. + $ oadm drain foo \-\-grace\-period=900 .fi .RE diff --git a/docs/man/man1/oadm-groups-new.1 b/docs/man/man1/oadm-groups-new.1 index 962e5dd29f10..b329205bc2b4 100644 --- a/docs/man/man1/oadm-groups-new.1 +++ b/docs/man/man1/oadm-groups-new.1 @@ -126,10 +126,10 @@ This command will create a new group with an optional list of users. .nf # Add a group with no users oadm groups new my\-group - + # Add a group with two users oadm groups new my\-group user1 user2 - + # Add a group with one user and shorter output oadm groups new my\-group user1 \-o name diff --git a/docs/man/man1/oadm-groups-prune.1 b/docs/man/man1/oadm-groups-prune.1 index dbb7572295c3..ed404c520ae4 100644 --- a/docs/man/man1/oadm-groups-prune.1 +++ b/docs/man/man1/oadm-groups-prune.1 @@ -16,13 +16,7 @@ oadm groups prune \- Prune OpenShift groups referencing missing records on an ex Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups oadm groups prune \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file oadm groups prune \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oadm groups prune \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oadm groups prune groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/oadm-groups-sync.1 b/docs/man/man1/oadm-groups-sync.1 index de0da52b8bde..b1cf50f29894 100644 --- a/docs/man/man1/oadm-groups-sync.1 +++ b/docs/man/man1/oadm-groups-sync.1 @@ -16,13 +16,7 @@ oadm groups sync \- Sync OpenShift groups with records from an external provider Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wishto sync and where their records live. For instance, all or some groups may be selected from the current Groupsstored in OpenShift that have been synced previously, or similarly all or some groups may be selected from thosestored on an LDAP server. The path to a sync configuration file is required in order to describe how data isrequested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-runwithout changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by theLDAP query templates. .SH OPTIONS @@ -152,20 +146,19 @@ LDAP query templates. .nf # Sync all groups from an LDAP server oadm groups sync \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server oadm groups sync \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific groups specified in a whitelist file with an LDAP server oadm groups sync \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server oadm groups sync \-\-type=openshift \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server oadm groups sync groups/group1 groups/group2 groups/group3 \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/oadm-ipfailover.1 b/docs/man/man1/oadm-ipfailover.1 index 9f2b81c98c30..53fca70ebf67 100644 --- a/docs/man/man1/oadm-ipfailover.1 +++ b/docs/man/man1/oadm-ipfailover.1 @@ -16,17 +16,10 @@ oadm ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for thecluster. An administrator can configure IP failover on an entirecluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name,the \-\-create flag can be passed to create a deployment configuration thatwill provide IP failover capability. If you are running in production, it isrecommended that the labeled selector for the nodes matches at least 2 nodesto ensure you have failover protection, and that you provide a \-\-replicas=value that matches the number of nodes for the given labeled selector. .SH OPTIONS @@ -164,18 +157,18 @@ value that matches the number of nodes for the given labeled selector. .nf # Check the default IP failover configuration ("ipfailover"): oadm ipfailover - + # See what the IP failover configuration would look like if it is created: oadm ipfailover \-o json - + # Create an IP failover configuration if it does not already exist: oadm ipfailover ipf \-\-virtual\-ips="10.1.1.1\-4" \-\-create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us\-west\-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). oadm ipfailover ipfailover \-\-selector="router=us\-west\-ha" \-\-virtual\-ips="1.2.3.4,10.1.1.100\-104,5.6.7.8" \-\-watch\-port=80 \-\-replicas=4 \-\-create - + # Use a different IP failover config image and see the configuration: oadm ipfailover ipf\-alt \-\-selector="hagroup=us\-west\-ha" \-\-virtual\-ips="1.2.3.4" \-o yaml \-\-images=myrepo/myipfailover:mytag diff --git a/docs/man/man1/oadm-manage-node.1 b/docs/man/man1/oadm-manage-node.1 index 3f2981a363b4..2e4f52d7f722 100644 --- a/docs/man/man1/oadm-manage-node.1 +++ b/docs/man/man1/oadm-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node andmarking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - oadm manage\-node \-\-schedulable=false - - # Mark selected nodes as schedulable - oadm manage\-node \-\-selector="" \-\-schedulable=true - - # Migrate selected pods - oadm manage\-node \-\-evacuate \-\-pod\-selector="" - - # Migrate selected pods, use a grace period of 60 seconds - oadm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - - # Migrate selected pods not backed by replication controller - oadm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - - # Show pods that will be migrated - oadm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - - # List all pods on given nodes - oadm manage\-node \-\-list\-pods + # Block accepting any pods on given nodes + oadm manage\-node \-\-schedulable=false + + # Mark selected nodes as schedulable + oadm manage\-node \-\-selector="" \-\-schedulable=true + + # Migrate selected pods + oadm manage\-node \-\-evacuate \-\-pod\-selector="" + + # Migrate selected pods, use a grace period of 60 seconds + oadm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + + # Migrate selected pods not backed by replication controller + oadm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + + # Show pods that will be migrated + oadm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + + # List all pods on given nodes + oadm manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/oadm-migrate-image-references.1 b/docs/man/man1/oadm-migrate-image-references.1 index 87964dff4eca..9e09c72a6662 100644 --- a/docs/man/man1/oadm-migrate-image-references.1 +++ b/docs/man/man1/oadm-migrate-image-references.1 @@ -16,34 +16,35 @@ oadm migrate image\-references \- Update embedded Docker image references Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default itwill update image streams and images, and may be used to update resources with a pod template(deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and thedesired registry and name. Either name or registry can be set to '*' to change all values.The registry value "docker.io" is special and will handle any image reference that refers tothe DockerHub. You may pass multiple mappings \- the first matching mapping will be appliedper resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs .IP -\(bu imagestreams * jobs +\(bu daemonsets .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs .IP -\(bu deploymentconfigs * pods +\(bu images +.IP +\(bu imagestreams +.IP +\(bu jobs +.IP +\(bu pods +.IP +\(bu replicationcontrollers .IP \(bu secrets (docker) .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and imagestreams requires administrative privileges. .SH OPTIONS @@ -149,16 +150,16 @@ streams requires administrative privileges. .nf # Perform a dry\-run of migrating all "docker.io" references to "myregistry.com" oadm migrate image\-references docker.io/*=myregistry.com/* - + # To actually perform the migration, the confirm flag must be appended oadm migrate image\-references docker.io/*=myregistry.com/* \-\-confirm - + # To see more details of what will be migrated, use the loglevel and output flags oadm migrate image\-references docker.io/*=myregistry.com/* \-\-loglevel=2 \-o yaml - + # Migrate from a service IP to an internal service DNS name oadm migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* - + # Migrate from a service IP to an internal service DNS name for all deployment configs and builds oadm migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* \-\-include=buildconfigs,deploymentconfigs diff --git a/docs/man/man1/oadm-migrate-storage.1 b/docs/man/man1/oadm-migrate-storage.1 index a99328bc4408..1750c2c4e2b1 100644 --- a/docs/man/man1/oadm-migrate-storage.1 +++ b/docs/man/man1/oadm-migrate-storage.1 @@ -16,25 +16,16 @@ oadm migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forcesthe server to write to the underlying storage if the object representation has changed. Use thiscommand to ensure that the most recent storage changes have been applied to all objects (storageversion, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a runthe command will output a list of resources that received errors, which you can then re\-run thecommand on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource namesto operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scopedresources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If youhave significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may alsoresult in significant intra\-cluster traffic. .SH OPTIONS @@ -140,17 +131,16 @@ WARNING: This is a slow command and will put significant load on an API server. .nf # Perform a dry\-run of updating all objects oadm migrate storage - + # To actually perform the update, the confirm flag must be appended oadm migrate storage \-\-confirm - + # Only migrate pods oadm migrate storage \-\-include=pods \-\-confirm - + # Only pods that are in namespaces starting with "bar" oadm migrate storage \-\-include=pods \-\-confirm \-\-from\-key=bar/ \-\-to\-key=bar/\\xFF - .fi .RE diff --git a/docs/man/man1/oadm-new-project.1 b/docs/man/man1/oadm-new-project.1 index 37dbc8a5ded4..54c3a09aa812 100644 --- a/docs/man/man1/oadm-new-project.1 +++ b/docs/man/man1/oadm-new-project.1 @@ -16,9 +16,7 @@ oadm new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project,an admin user (and role, if you want to use a non\-default admin role), and a node selectorto restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/oadm-pod-network-isolate-projects.1 b/docs/man/man1/oadm-pod-network-isolate-projects.1 index 77740c2a4040..232abc2c4b62 100644 --- a/docs/man/man1/oadm-pod-network-isolate-projects.1 +++ b/docs/man/man1/oadm-pod-network-isolate-projects.1 @@ -96,11 +96,11 @@ Allows projects to isolate their network from other projects when using the redh .RS .nf - # Provide isolation for project p1 - oadm pod\-network isolate\-projects - - # Allow all projects with label name=top\-secret to have their own isolated project network - oadm pod\-network isolate\-projects \-\-selector='name=top\-secret' + # Provide isolation for project p1 + oadm pod\-network isolate\-projects + + # Allow all projects with label name=top\-secret to have their own isolated project network + oadm pod\-network isolate\-projects \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/oadm-pod-network-join-projects.1 b/docs/man/man1/oadm-pod-network-join-projects.1 index 5e77c0c0a0db..6686a5b14e18 100644 --- a/docs/man/man1/oadm-pod-network-join-projects.1 +++ b/docs/man/man1/oadm-pod-network-join-projects.1 @@ -100,11 +100,11 @@ Allows projects to join existing project network when using the redhat/openshift .RS .nf - # Allow project p2 to use project p1 network - oadm pod\-network join\-projects \-\-to= - - # Allow all projects with label name=top\-secret to use project p1 network - oadm pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' + # Allow project p2 to use project p1 network + oadm pod\-network join\-projects \-\-to= + + # Allow all projects with label name=top\-secret to use project p1 network + oadm pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/oadm-pod-network-make-projects-global.1 b/docs/man/man1/oadm-pod-network-make-projects-global.1 index e0d280d17b34..8e4c667d26a9 100644 --- a/docs/man/man1/oadm-pod-network-make-projects-global.1 +++ b/docs/man/man1/oadm-pod-network-make-projects-global.1 @@ -96,11 +96,11 @@ Allows projects to access all pods in the cluster and vice versa when using the .RS .nf - # Allow project p1 to access all pods in the cluster and vice versa - oadm pod\-network make\-projects\-global - - # Allow all projects with label name=share to access all pods in the cluster and vice versa - oadm pod\-network make\-projects\-global \-\-selector='name=share' + # Allow project p1 to access all pods in the cluster and vice versa + oadm pod\-network make\-projects\-global + + # Allow all projects with label name=share to access all pods in the cluster and vice versa + oadm pod\-network make\-projects\-global \-\-selector='name=share' .fi .RE diff --git a/docs/man/man1/oadm-policy-add-role-to-user.1 b/docs/man/man1/oadm-policy-add-role-to-user.1 index 9ccd71d2f579..e814b6506b52 100644 --- a/docs/man/man1/oadm-policy-add-role-to-user.1 +++ b/docs/man/man1/oadm-policy-add-role-to-user.1 @@ -99,7 +99,7 @@ Add a role to users or serviceaccounts for the current project .nf # Add the 'view' role to user1 for the current project oadm policy add\-role\-to\-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project oadm policy add\-role\-to\-user edit \-z serviceaccount1 diff --git a/docs/man/man1/oadm-policy-add-scc-to-user.1 b/docs/man/man1/oadm-policy-add-scc-to-user.1 index 3fa6f47307d7..c00449ff5c4e 100644 --- a/docs/man/man1/oadm-policy-add-scc-to-user.1 +++ b/docs/man/man1/oadm-policy-add-scc-to-user.1 @@ -95,7 +95,7 @@ Add users or serviceaccount to a security context constraint .nf # Add the 'restricted' security context contraint to user1 and user2 oadm policy add\-scc\-to\-user restricted user1 user2 - + # Add the 'privileged' security context contraint to the service account serviceaccount1 in the current namespace oadm policy add\-scc\-to\-user privileged \-z serviceaccount1 diff --git a/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 index 6fa7c4cfb219..7e60092fe726 100644 --- a/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ oadm policy reconcile\-cluster\-role\-bindings \- Update cluster role bindings t Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy.Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding.This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. @@ -147,16 +145,16 @@ You can see which recommended cluster role bindings have changed by choosing an .nf # Display the names of cluster role bindings that would be modified oadm policy reconcile\-cluster\-role\-bindings \-o name - + # Display the cluster role bindings that would be modified, removing any extra subjects oadm policy reconcile\-cluster\-role\-bindings \-\-additive\-only=false - + # Update cluster role bindings that don't match the current defaults oadm policy reconcile\-cluster\-role\-bindings \-\-confirm - + # Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group oadm policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-exclude\-groups=system:authenticated - + # Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding oadm policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-additive\-only=false diff --git a/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 b/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 index 74bb070b6a88..b2cdc37ea806 100644 --- a/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ oadm policy reconcile\-cluster\-roles \- Update cluster roles to match the recom Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster rolethat does not match will be replaced by the recommended bootstrap role. This command will not removeany additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. @@ -142,14 +140,14 @@ You can see which cluster roles have recommended changed by choosing an output t .nf # Display the names of cluster roles that would be modified oadm policy reconcile\-cluster\-roles \-o name - + # Add missing permissions to cluster roles that don't match the current defaults oadm policy reconcile\-cluster\-roles \-\-confirm - + # Add missing permissions and remove extra permissions from # cluster roles that don't match the current defaults oadm policy reconcile\-cluster\-roles \-\-additive\-only=false \-\-confirm - + # Display the union of the default and modified cluster roles oadm policy reconcile\-cluster\-roles \-\-additive\-only diff --git a/docs/man/man1/oadm-policy-reconcile-sccs.1 b/docs/man/man1/oadm-policy-reconcile-sccs.1 index a4659b5d134f..d4c20e82acfe 100644 --- a/docs/man/man1/oadm-policy-reconcile-sccs.1 +++ b/docs/man/man1/oadm-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ oadm policy reconcile\-sccs \- Replace cluster SCCs to match the recommended boo Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs.Any cluster SCC that does not match will be replaced by the recommended SCC.This command will not remove any additional cluster SCCs. By default, this commandwill not remove additional users and groups that have been granted access to the SCC andwill preserve existing priorities (but will always reconcile unset priorities and the policydefinition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. @@ -146,11 +141,11 @@ You can see which cluster SCCs have recommended changes by choosing an output ty .nf # Display the cluster SCCs that would be modified oadm policy reconcile\-sccs - + # Update cluster SCCs that don't match the current defaults preserving additional grants # for users and group and keeping any priorities that are already set oadm policy reconcile\-sccs \-\-confirm - + # Replace existing users, groups, and priorities that do not match defaults oadm policy reconcile\-sccs \-\-additive\-only=false \-\-confirm diff --git a/docs/man/man1/oadm-policy.1 b/docs/man/man1/oadm-policy.1 index f5e485eb6599..89bd61b8e985 100644 --- a/docs/man/man1/oadm-policy.1 +++ b/docs/man/man1/oadm-policy.1 @@ -16,13 +16,10 @@ oadm policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcilecommands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the followingresources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings',and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-prune-builds.1 b/docs/man/man1/oadm-prune-builds.1 index 3462dd20e33b..e25576a4bb64 100644 --- a/docs/man/man1/oadm-prune-builds.1 +++ b/docs/man/man1/oadm-prune-builds.1 @@ -16,8 +16,7 @@ oadm prune builds \- Remove old completed and failed builds Prune old completed and failed builds .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -116,7 +115,7 @@ By default, the prune operation performs a dry run making no changes to internal # Dry run deleting older completed and failed builds and also including # all builds whose associated BuildConfig no longer exists oadm prune builds \-\-orphans - + # To actually perform the prune operation, the confirm flag must be appended oadm prune builds \-\-orphans \-\-confirm diff --git a/docs/man/man1/oadm-prune-deployments.1 b/docs/man/man1/oadm-prune-deployments.1 index 294c133902d6..98889b996885 100644 --- a/docs/man/man1/oadm-prune-deployments.1 +++ b/docs/man/man1/oadm-prune-deployments.1 @@ -16,8 +16,7 @@ oadm prune deployments \- Remove old completed and failed deployments Prune old completed and failed deployments .PP -By default, the prune operation performs a dry run making no changes to the deployments. -A \-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to the deployments.A \-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -115,7 +114,7 @@ A \-\-confirm flag is needed for changes to be effective. .nf # Dry run deleting all but the last complete deployment for every deployment config oadm prune deployments \-\-keep\-complete=1 - + # To actually perform the prune operation, the confirm flag must be appended oadm prune deployments \-\-keep\-complete=1 \-\-confirm diff --git a/docs/man/man1/oadm-prune-groups.1 b/docs/man/man1/oadm-prune-groups.1 index 7fd3aa8e5e65..c113fd2638d2 100644 --- a/docs/man/man1/oadm-prune-groups.1 +++ b/docs/man/man1/oadm-prune-groups.1 @@ -16,13 +16,7 @@ oadm prune groups \- Prune OpenShift groups referencing missing records on an ex Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups oadm prune groups \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file oadm prune groups \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oadm prune groups \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oadm prune groups groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/oadm-prune-images.1 b/docs/man/man1/oadm-prune-images.1 index 5130f44bef34..78852e8bb82e 100644 --- a/docs/man/man1/oadm-prune-images.1 +++ b/docs/man/man1/oadm-prune-images.1 @@ -16,12 +16,10 @@ oadm prune images \- Remove unreferenced images Prune images no longer needed due to age and/or status .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .PP -Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete the -images. +Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete theimages. .SH OPTIONS @@ -120,14 +118,14 @@ images. # See, what the prune command would delete if only images more than an hour old and obsoleted # by 3 newer revisions under the same tag were considered. oadm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m - + # To actually perform the prune operation, the confirm flag must be appended oadm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm - + # See, what the prune command would delete if we're interested in removing images # exceeding currently set LimitRanges ('openshift.io/Image') oadm prune images \-\-prune\-over\-size\-limit - + # To actually perform the prune operation, the confirm flag must be appended oadm prune images \-\-prune\-over\-size\-limit \-\-confirm diff --git a/docs/man/man1/oadm-prune.1 b/docs/man/man1/oadm-prune.1 index 905a0fc987df..471963a0139a 100644 --- a/docs/man/man1/oadm-prune.1 +++ b/docs/man/man1/oadm-prune.1 @@ -16,8 +16,7 @@ oadm prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources onthe system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-registry.1 b/docs/man/man1/oadm-registry.1 index 21ad9981e92f..49ab202a155e 100644 --- a/docs/man/man1/oadm-registry.1 +++ b/docs/man/man1/oadm-registry.1 @@ -16,28 +16,16 @@ oadm registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications whenimages are pushed. With no arguments, the command will check for the existing registry servicecalled 'docker\-registry' and try to create it. If you want to test whether the registry hasbeen created add the \-\-dry\-run flag and the command will exit with 1 if the registry does notexist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like anobject store (several are supported by the Docker registry). The default Docker registry imageis configured to accept configuration as environment variables \- refer to the configuration file inthat image for more on setting up alternative storage. Once you've made those changes, you canpass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setupuses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will bechosen for use as the REGISTRYHTTPADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a newinstallation. Some configuration beyond this command is still required to makeyour registry persist data. .SH OPTIONS @@ -191,16 +179,16 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .nf # Check if default Docker registry ("docker\-registry") has been created oadm registry \-\-dry\-run - + # See what the registry will look like if created oadm registry \-o yaml - + # Create a registry with two replicas if it does not exist oadm registry \-\-replicas=2 - + # Use a different registry image oadm registry \-\-images=myrepo/docker\-registry:mytag - + # Enforce quota and limits on images oadm registry \-\-enforce\-quota diff --git a/docs/man/man1/oadm-router.1 b/docs/man/man1/oadm-router.1 index 0bd235485e29..969a86b91d97 100644 --- a/docs/man/man1/oadm-router.1 +++ b/docs/man/man1/oadm-router.1 @@ -16,17 +16,10 @@ oadm router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it toyour application. With no arguments, the command will check for an existing routerservice called 'router' and create one if it does not exist. If you want to test whethera router has already been created add the \-\-dry\-run flag and the command will exit with1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command willcreate a deployment configuration and service that will run the router. If you arerunning your router in production, you should pass \-\-replicas=2 or higher to ensureyou have failover protection. .SH OPTIONS @@ -232,19 +225,18 @@ you have failover protection. .nf # Check the default router ("router") oadm router \-\-dry\-run - + # See what the router would look like if created oadm router \-o yaml - + # Create a router with two replicas if it does not exist oadm router router\-west \-\-replicas=2 - + # Use a different router image oadm router region\-west \-\-images=myrepo/somerouter:mytag - + # Run the router with a hint to the underlying implementation to \_not\_ expose statistics. oadm router router\-west \-\-stats\-port=0 - .fi .RE diff --git a/docs/man/man1/oadm-taint.1 b/docs/man/man1/oadm-taint.1 index 5b4fef4b6a90..5617bab65dac 100644 --- a/docs/man/man1/oadm-taint.1 +++ b/docs/man/man1/oadm-taint.1 @@ -16,11 +16,7 @@ oadm taint \- Update the taints on one or more nodes Update the taints on one or more nodes. .PP -A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. -The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The effect must be NoSchedule or PreferNoSchedule. -Currently taint can only apply to node. +A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The effect must be NoSchedule or PreferNoSchedule.Currently taint can only apply to node. .SH OPTIONS @@ -152,16 +148,15 @@ Currently taint can only apply to node. .RS .nf - -# Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. -# If a taint with that key and effect already exists, its value is replaced as specified. -oadm taint nodes foo dedicated=special\-user:NoSchedule - -# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. -oadm taint nodes foo dedicated:NoSchedule\- - -# Remove from node 'foo' all the taints with key 'dedicated' -oadm taint nodes foo dedicated\- + # Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. + # If a taint with that key and effect already exists, its value is replaced as specified. + oadm taint nodes foo dedicated=special\-user:NoSchedule + + # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. + oadm taint nodes foo dedicated:NoSchedule\- + + # Remove from node 'foo' all the taints with key 'dedicated' + oadm taint nodes foo dedicated\- .fi .RE diff --git a/docs/man/man1/oadm-top-images.1 b/docs/man/man1/oadm-top-images.1 index 67a57775e087..a5ef8bab1bbb 100644 --- a/docs/man/man1/oadm-top-images.1 +++ b/docs/man/man1/oadm-top-images.1 @@ -16,8 +16,7 @@ oadm top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-top-imagestreams.1 b/docs/man/man1/oadm-top-imagestreams.1 index c283919b7cd7..327630b7d97f 100644 --- a/docs/man/man1/oadm-top-imagestreams.1 +++ b/docs/man/man1/oadm-top-imagestreams.1 @@ -16,8 +16,7 @@ oadm top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-top-node.1 b/docs/man/man1/oadm-top-node.1 index 5bff386acf83..400546981c6a 100644 --- a/docs/man/man1/oadm-top-node.1 +++ b/docs/man/man1/oadm-top-node.1 @@ -96,12 +96,11 @@ The top\-node command allows you to see the resource consumption of nodes. .RS .nf - -# Show metrics for all nodes -kubectl top node - -# Show metrics for a given node -kubectl top node NODE\_NAME + # Show metrics for all nodes + kubectl top node + + # Show metrics for a given node + kubectl top node NODE\_NAME .fi .RE diff --git a/docs/man/man1/oadm-top-pod.1 b/docs/man/man1/oadm-top-pod.1 index 47828c1eeab4..9051a8d7b486 100644 --- a/docs/man/man1/oadm-top-pod.1 +++ b/docs/man/man1/oadm-top-pod.1 @@ -19,8 +19,7 @@ Display Resource (CPU/Memory/Storage) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. .PP -Due to the metrics pipeline delay, they may be unavailable for a few minutes -since pod creation. +Due to the metrics pipeline delay, they may be unavailable for a few minutessince pod creation. .SH OPTIONS @@ -108,18 +107,17 @@ since pod creation. .RS .nf - -# Show metrics for all pods in the default namespace -kubectl top pod - -# Show metrics for all pods in the given namespace -kubectl top pod \-\-namespace=NAMESPACE - -# Show metrics for a given pod and its containers -kubectl top pod POD\_NAME \-\-containers - -# Show metrics for the pods defined by label name=myLabel -kubectl top pod \-l name=myLabel + # Show metrics for all pods in the default namespace + kubectl top pod + + # Show metrics for all pods in the given namespace + kubectl top pod \-\-namespace=NAMESPACE + + # Show metrics for a given pod and its containers + kubectl top pod POD\_NAME \-\-containers + + # Show metrics for the pods defined by label name=myLabel + kubectl top pod \-l name=myLabel .fi .RE diff --git a/docs/man/man1/oadm-top.1 b/docs/man/man1/oadm-top.1 index 41b94b4da541..9631139623ab 100644 --- a/docs/man/man1/oadm-top.1 +++ b/docs/man/man1/oadm-top.1 @@ -16,8 +16,7 @@ oadm top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oadm-uncordon.1 b/docs/man/man1/oadm-uncordon.1 index 77bd75938698..45b247a2e700 100644 --- a/docs/man/man1/oadm-uncordon.1 +++ b/docs/man/man1/oadm-uncordon.1 @@ -87,10 +87,8 @@ Mark node as schedulable. .RS .nf - -# Mark node "foo" as schedulable. -$ oadm uncordon foo - + # Mark node "foo" as schedulable. + $ oadm uncordon foo .fi .RE diff --git a/docs/man/man1/oadm.1 b/docs/man/man1/oadm.1 index f84a71383bd2..9d750ebed79a 100644 --- a/docs/man/man1/oadm.1 +++ b/docs/man/man1/oadm.1 @@ -16,8 +16,7 @@ oadm \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrativeactions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-build-chain.1 b/docs/man/man1/oc-adm-build-chain.1 index c347392697dd..af00bc6bcaf1 100644 --- a/docs/man/man1/oc-adm-build-chain.1 +++ b/docs/man/man1/oc-adm-build-chain.1 @@ -16,9 +16,7 @@ oc adm build\-chain \- Output the inputs and dependencies of your builds Output the inputs and dependencies of your builds .PP -Supported formats for the generated graph are dot and a human\-readable output. -Tag and namespace are optional and if they are not specified, 'latest' and the -default namespace will be used respectively. +Supported formats for the generated graph are dot and a human\-readable output.Tag and namespace are optional and if they are not specified, 'latest' and thedefault namespace will be used respectively. .SH OPTIONS @@ -112,10 +110,10 @@ default namespace will be used respectively. .nf # Build the dependency tree for the 'latest' tag in oc adm build\-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility oc adm build\-chain :v2 \-o dot | dot \-T svg \-o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace oc adm build\-chain \-n test \-\-all diff --git a/docs/man/man1/oc-adm-ca-create-key-pair.1 b/docs/man/man1/oc-adm-ca-create-key-pair.1 index 8e3760423f63..4c400ea6004a 100644 --- a/docs/man/man1/oc-adm-ca-create-key-pair.1 +++ b/docs/man/man1/oc-adm-ca-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -oc adm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + oc adm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/oc-adm-ca-create-master-certs.1 b/docs/man/man1/oc-adm-ca-create-master-certs.1 index 8893088e457f..c593cac3e341 100644 --- a/docs/man/man1/oc-adm-ca-create-master-certs.1 +++ b/docs/man/man1/oc-adm-ca-create-master-certs.1 @@ -16,66 +16,39 @@ oc adm ca create\-master\-certs \- Create certificates and keys for a master Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -oc adm ca create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + oc adm ca create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-ca-create-server-cert.1 b/docs/man/man1/oc-adm-ca-create-server-cert.1 index 845da63d50c7..69667c314019 100644 --- a/docs/man/man1/oc-adm-ca-create-server-cert.1 +++ b/docs/man/man1/oc-adm-ca-create-server-cert.1 @@ -16,26 +16,18 @@ oc adm ca create\-server\-cert \- Create a signed server certificate and key Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -oc adm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + oc adm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/oc-adm-ca-decrypt.1 b/docs/man/man1/oc-adm-ca-decrypt.1 index 9f904b3b0319..d2cb54558e06 100644 --- a/docs/man/man1/oc-adm-ca-decrypt.1 +++ b/docs/man/man1/oc-adm-ca-decrypt.1 @@ -101,12 +101,11 @@ Decrypt data encrypted with "oc adm ca encrypt" .RS .nf - # Decrypt an encrypted file to a cleartext file: - oc adm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - - # Decrypt from stdin to stdout: - oc adm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted - + # Decrypt an encrypted file to a cleartext file: + oc adm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted + + # Decrypt from stdin to stdout: + oc adm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted .fi .RE diff --git a/docs/man/man1/oc-adm-ca-encrypt.1 b/docs/man/man1/oc-adm-ca-encrypt.1 index 05a91e51e182..16ac877d02ac 100644 --- a/docs/man/man1/oc-adm-ca-encrypt.1 +++ b/docs/man/man1/oc-adm-ca-encrypt.1 @@ -105,12 +105,11 @@ Encrypt data with AES\-256\-CBC encryption .RS .nf - # Encrypt the content of secret.txt with a generated key: - oc adm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - - # Encrypt the content of secret2.txt with an existing key: - oc adm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted - + # Encrypt the content of secret.txt with a generated key: + oc adm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted + + # Encrypt the content of secret2.txt with an existing key: + oc adm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted .fi .RE diff --git a/docs/man/man1/oc-adm-completion.1 b/docs/man/man1/oc-adm-completion.1 index 07447d5bfd13..987d6d265a66 100644 --- a/docs/man/man1/oc-adm-completion.1 +++ b/docs/man/man1/oc-adm-completion.1 @@ -13,8 +13,7 @@ oc adm completion \- Output shell completion code for the given shell (bash or z .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of oc adm commands. +This command prints shell code which must be evaluated to provide interactivecompletion of oc adm commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -91,18 +90,19 @@ completion of oc adm commands. # Generate the oc adm completion code for bash oc adm completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion oc adm completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(oc adm completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/oc-adm-config-current-context.1 b/docs/man/man1/oc-adm-config-current-context.1 index 17367962cb80..76e940e71e2e 100644 --- a/docs/man/man1/oc-adm-config-current-context.1 +++ b/docs/man/man1/oc-adm-config-current-context.1 @@ -87,7 +87,6 @@ Displays the current\-context .RS .nf - # Display the current\-context oc adm config current\-context diff --git a/docs/man/man1/oc-adm-config-set-cluster.1 b/docs/man/man1/oc-adm-config-set-cluster.1 index 7b604c336650..65b79016b5bb 100644 --- a/docs/man/man1/oc-adm-config-set-cluster.1 +++ b/docs/man/man1/oc-adm-config-set-cluster.1 @@ -13,8 +13,7 @@ oc adm config set\-cluster \- Sets a cluster entry in kubeconfig .SH DESCRIPTION .PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set only the server field on the e2e cluster entry without touching other values. oc adm config set\-cluster e2e \-\-server=https://1.2.3.4 diff --git a/docs/man/man1/oc-adm-config-set-context.1 b/docs/man/man1/oc-adm-config-set-context.1 index e5fadf6530e4..2cf73a12afcb 100644 --- a/docs/man/man1/oc-adm-config-set-context.1 +++ b/docs/man/man1/oc-adm-config-set-context.1 @@ -13,8 +13,7 @@ oc adm config set\-context \- Sets a context entry in kubeconfig .SH DESCRIPTION .PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set the user field on the gce context entry without touching other values oc adm config set\-context gce \-\-user=cluster\-admin diff --git a/docs/man/man1/oc-adm-config-set-credentials.1 b/docs/man/man1/oc-adm-config-set-credentials.1 index f911faadeb57..1178190f5229 100644 --- a/docs/man/man1/oc-adm-config-set-credentials.1 +++ b/docs/man/man1/oc-adm-config-set-credentials.1 @@ -13,20 +13,16 @@ oc adm config set\-credentials \- Sets a user entry in kubeconfig .SH DESCRIPTION .PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. +Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values. .PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile +Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile .PP -Bearer token flags: - \-\-token=bearer\_token +Bearer token flags:\-\-token=bearer\_token .PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password +Basic auth flags:\-\-username=basicuser \-\-password=basicpassword .PP Bearer token and basic auth are mutually exclusive. @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive. .RS .nf - # Set only the "client\-key" field on the "cluster\-admin" # entry, without touching other values: oc adm config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key diff --git a/docs/man/man1/oc-adm-config-set.1 b/docs/man/man1/oc-adm-config-set.1 index 2c58894646f6..361a0a04196d 100644 --- a/docs/man/man1/oc-adm-config-set.1 +++ b/docs/man/man1/oc-adm-config-set.1 @@ -13,9 +13,7 @@ oc adm config set \- Sets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. +Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-config-unset.1 b/docs/man/man1/oc-adm-config-unset.1 index 410387ef2d83..06b46ca81ba0 100644 --- a/docs/man/man1/oc-adm-config-unset.1 +++ b/docs/man/man1/oc-adm-config-unset.1 @@ -13,8 +13,7 @@ oc adm config unset \- Unsets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. +Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-config-view.1 b/docs/man/man1/oc-adm-config-view.1 index b52ec5127838..35831b3ea4ea 100644 --- a/docs/man/man1/oc-adm-config-view.1 +++ b/docs/man/man1/oc-adm-config-view.1 @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat .RS .nf - # Show Merged kubeconfig settings. oc adm config view diff --git a/docs/man/man1/oc-adm-config.1 b/docs/man/man1/oc-adm-config.1 index 4e455596efa0..b004cf740b2f 100644 --- a/docs/man/man1/oc-adm-config.1 +++ b/docs/man/man1/oc-adm-config.1 @@ -16,9 +16,7 @@ oc adm config \- Change configuration files for the client Manage the client config files .PP -The client stores configuration in the current user's home directory (under the .kube directory as -config). When you login the first time, a new config file is created, and subsequent project changes with the -'project' command will set the current context. These subcommands allow you to manage the config directly. +The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly. .PP Reference: diff --git a/docs/man/man1/oc-adm-cordon.1 b/docs/man/man1/oc-adm-cordon.1 index 18f29bcf0d05..70827f1ebd69 100644 --- a/docs/man/man1/oc-adm-cordon.1 +++ b/docs/man/man1/oc-adm-cordon.1 @@ -87,10 +87,8 @@ Mark node as unschedulable. .RS .nf - -# Mark node "foo" as unschedulable. -oc adm cordon foo - + # Mark node "foo" as unschedulable. + oc adm cordon foo .fi .RE diff --git a/docs/man/man1/oc-adm-create-api-client-config.1 b/docs/man/man1/oc-adm-create-api-client-config.1 index 533c2695f5e5..a15e42d17e4d 100644 --- a/docs/man/man1/oc-adm-create-api-client-config.1 +++ b/docs/man/man1/oc-adm-create-api-client-config.1 @@ -16,9 +16,7 @@ oc adm create\-api\-client\-config \- Create a config file for connecting to the Create a client configuration for connecting to the server .PP -This command creates a folder containing a client certificate, a client key, -a server certificate authority, and a .kubeconfig file for connecting to the -master as the provided user. +This command creates a folder containing a client certificate, a client key,a server certificate authority, and a .kubeconfig file for connecting to themaster as the provided user. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-create-error-template.1 b/docs/man/man1/oc-adm-create-error-template.1 index 0a598a3e7505..e27a269acbc2 100644 --- a/docs/man/man1/oc-adm-create-error-template.1 +++ b/docs/man/man1/oc-adm-create-error-template.1 @@ -16,24 +16,15 @@ oc adm create\-error\-template \- Create an error page template Create a template for customizing the error page .PP -This command creates a basic template to use as a starting point for -customizing the authentication error page. Save the output to a file and edit -the template to change the look and feel or add content. +This command creates a basic template to use as a starting point forcustomizing the authentication error page. Save the output to a file and editthe template to change the look and feel or add content. .PP -To use the template, set oauthConfig.templates.error in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.error in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - error: templates/error.html - -.fi -.RE + templates: + error: templates/error.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-create-key-pair.1 b/docs/man/man1/oc-adm-create-key-pair.1 index eac349f69f12..1f879665fc71 100644 --- a/docs/man/man1/oc-adm-create-key-pair.1 +++ b/docs/man/man1/oc-adm-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -oc adm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + oc adm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/oc-adm-create-kubeconfig.1 b/docs/man/man1/oc-adm-create-kubeconfig.1 index b1b414354651..0472942788ec 100644 --- a/docs/man/man1/oc-adm-create-kubeconfig.1 +++ b/docs/man/man1/oc-adm-create-kubeconfig.1 @@ -13,36 +13,36 @@ oc adm create\-kubeconfig \- Create a basic .kubeconfig file from client certs .SH DESCRIPTION .PP -Create's a .kubeconfig file at <\-\-kubeconfig> that looks like this: +Create's a .kubeconfig file at<\-\-kubeconfig> that looks like this: .PP clusters: -\- cluster: - certificate\-authority\-data: - server: <\-\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-master> name: <\-\-cluster> -\- cluster: - certificate\-authority\-data: - server: <\-\-public\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-public\-master> name: public\-<\-\-cluster> -contexts: -\- context: - cluster: <\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + contexts: + \- context: + cluster: <\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: <\-\-context> -\- context: - cluster: public\-<\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + \- context: + cluster: public\-<\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: public\-<\-\-context> -current\-context: <\-\-context> -kind: Config -users: -\- name: <\-\-user> + current\-context: <\-\-context> + kind: Config + users: + \- name: <\-\-user> user: - client\-certificate\-data: - client\-key\-data: + client\-certificate\-data: + client\-key\-data: .SH OPTIONS diff --git a/docs/man/man1/oc-adm-create-login-template.1 b/docs/man/man1/oc-adm-create-login-template.1 index a4fbeb471b6f..33bf9b9ca3a2 100644 --- a/docs/man/man1/oc-adm-create-login-template.1 +++ b/docs/man/man1/oc-adm-create-login-template.1 @@ -16,25 +16,15 @@ oc adm create\-login\-template \- Create a login template Create a template for customizing the login page .PP -This command creates a basic template to use as a starting point for -customizing the login page. Save the output to a file and edit the template to -change the look and feel or add content. Be careful not to remove any parameter -values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login page. Save the output to a file and edit the template tochange the look and feel or add content. Be careful not to remove any parametervalues inside curly braces. .PP -To use the template, set oauthConfig.templates.login in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.login in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - login: templates/login.html - -.fi -.RE + templates: + login: templates/login.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-create-master-certs.1 b/docs/man/man1/oc-adm-create-master-certs.1 index c7156f2ca002..4969ed1a6bd3 100644 --- a/docs/man/man1/oc-adm-create-master-certs.1 +++ b/docs/man/man1/oc-adm-create-master-certs.1 @@ -16,66 +16,39 @@ oc adm create\-master\-certs \- Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -oc adm create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + oc adm create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-create-provider-selection-template.1 b/docs/man/man1/oc-adm-create-provider-selection-template.1 index b67309e17196..75ee8df2a34a 100644 --- a/docs/man/man1/oc-adm-create-provider-selection-template.1 +++ b/docs/man/man1/oc-adm-create-provider-selection-template.1 @@ -16,25 +16,15 @@ oc adm create\-provider\-selection\-template \- Create a provider selection temp Create a template for customizing the provider selection page .PP -This command creates a basic template to use as a starting point for -customizing the login provider selection page. Save the output to a file and edit -the template to change the look and feel or add content. Be careful not to remove -any parameter values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login provider selection page. Save the output to a file and editthe template to change the look and feel or add content. Be careful not to removeany parameter values inside curly braces. .PP -To use the template, set oauthConfig.templates.providerSelection in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.providerSelection in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - providerSelection: templates/provider\-selection.html - -.fi -.RE + templates: + providerSelection: templates/provider\-selection.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-create-server-cert.1 b/docs/man/man1/oc-adm-create-server-cert.1 index 5c503803952d..0aa346ce2ab7 100644 --- a/docs/man/man1/oc-adm-create-server-cert.1 +++ b/docs/man/man1/oc-adm-create-server-cert.1 @@ -16,26 +16,18 @@ oc adm create\-server\-cert \- Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -oc adm create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + oc adm create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/oc-adm-diagnostics.1 b/docs/man/man1/oc-adm-diagnostics.1 index 3be7d64b9429..35000cb05158 100644 --- a/docs/man/man1/oc-adm-diagnostics.1 +++ b/docs/man/man1/oc-adm-diagnostics.1 @@ -13,59 +13,32 @@ oc adm diagnostics \- Diagnose common cluster problems .SH DESCRIPTION .PP -This utility helps troubleshoot and diagnose known problems. It runs -diagnostics using a client and/or the state of a running master / -node host. +This utility helps troubleshoot and diagnose known problems. It runsdiagnostics using a client and/or the state of a running master /node host. .PP -.RS - -.nf oc adm diagnostics -.fi -.RE - .PP -If run without flags, it will check for standard config files for -client, master, and node, and if found, use them for diagnostics. -You may also specify config files explicitly with flags, in which case -you will receive an error if they are not found. For example: +If run without flags, it will check for standard config files forclient, master, and node, and if found, use them for diagnostics.You may also specify config files explicitly with flags, in which caseyou will receive an error if they are not found. For example: .PP -.RS - -.nf oc adm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml - -.fi -.RE .IP .IP -\(bu If master/node config files are not found and the \-\-host flag is not -present, host diagnostics are skipped. +\(bu If master/node config files are not found and the \-\-host flag is notpresent, host diagnostics are skipped. .IP -\(bu If the client has cluster\-admin access, this access enables cluster -diagnostics to run which regular users cannot. +\(bu If the client has cluster\-admin access, this access enables clusterdiagnostics to run which regular users cannot. .IP -\(bu If a client config file is not found, client and cluster diagnostics -are skipped. +\(bu If a client config file is not found, client and cluster diagnosticsare skipped. .PP Diagnostics may be individually run by passing diagnostic name as arguments. .PP -.RS - -.nf oc adm diagnostics -.fi -.RE - .PP -The available diagnostic names are: -AggregatedLogging AnalyzeLogs ClusterRegistry ClusterRoleBindings ClusterRoles ClusterRouter ConfigContexts DiagnosticPod MasterConfigCheck MasterNode MetricsApiProxy NodeConfigCheck NodeDefinitions ServiceExternalIPs UnitStatus +The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegistry, ClusterRoleBindings, ClusterRoles, ClusterRouter, ConfigContexts, DiagnosticPod, MasterConfigCheck, MasterNode, MetricsApiProxy, NodeConfigCheck, NodeDefinitions, ServiceExternalIPs, UnitStatus. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-drain.1 b/docs/man/man1/oc-adm-drain.1 index 3f91c61354ff..56446fab455a 100644 --- a/docs/man/man1/oc-adm-drain.1 +++ b/docs/man/man1/oc-adm-drain.1 @@ -16,22 +16,14 @@ oc adm drain \- Drain node in preparation for maintenance Drain node in preparation for maintenance. .PP -The given node will be marked unschedulable to prevent new pods from arriving. -Then drain deletes all pods except mirror pods (which cannot be deleted through -the API server). If there are DaemonSet\-managed pods, drain will not proceed -without \-\-ignore\-daemonsets, and regardless it will not delete any -DaemonSet\-managed pods, because those pods would be immediately replaced by the -DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed\-\-by ReplicationController, -ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless you -use \-\-force. +The given node will be marked unschedulable to prevent new pods from arriving.Then drain deletes all pods except mirror pods (which cannot be deleted throughthe API server). If there are DaemonSet\-managed pods, drain will not proceedwithout \-\-ignore\-daemonsets, and regardless it will not delete anyDaemonSet\-managed pods, because those pods would be immediately replaced by theDaemonSet controller, which ignores unschedulable markings. If there are anypods that are neither mirror pods nor managed\-\-by ReplicationController,ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless youuse \-\-force. .PP -When you are ready to put the node back into service, use kubectl uncordon, which -will make the node schedulable again. +When you are ready to put the node back into service, use kubectl uncordon, whichwill make the node schedulable again. .PP +\[la]http://kubernetes.io/images/docs/kubectl_drain.svg\[ra] .SH OPTIONS @@ -123,13 +115,11 @@ will make the node schedulable again. .RS .nf - -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ oc adm drain foo \-\-force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ oc adm drain foo \-\-grace\-period=900 - + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. + $ oc adm drain foo \-\-force + + # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. + $ oc adm drain foo \-\-grace\-period=900 .fi .RE diff --git a/docs/man/man1/oc-adm-groups-new.1 b/docs/man/man1/oc-adm-groups-new.1 index acc5c6b5cddd..9e66667ba5f5 100644 --- a/docs/man/man1/oc-adm-groups-new.1 +++ b/docs/man/man1/oc-adm-groups-new.1 @@ -126,10 +126,10 @@ This command will create a new group with an optional list of users. .nf # Add a group with no users oc adm groups new my\-group - + # Add a group with two users oc adm groups new my\-group user1 user2 - + # Add a group with one user and shorter output oc adm groups new my\-group user1 \-o name diff --git a/docs/man/man1/oc-adm-groups-prune.1 b/docs/man/man1/oc-adm-groups-prune.1 index b71202abdd2b..907b6b81ce77 100644 --- a/docs/man/man1/oc-adm-groups-prune.1 +++ b/docs/man/man1/oc-adm-groups-prune.1 @@ -16,13 +16,7 @@ oc adm groups prune \- Prune OpenShift groups referencing missing records on an Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups oc adm groups prune \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file oc adm groups prune \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oc adm groups prune \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oc adm groups prune groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/oc-adm-groups-sync.1 b/docs/man/man1/oc-adm-groups-sync.1 index 96392e8f8503..132e7702e85a 100644 --- a/docs/man/man1/oc-adm-groups-sync.1 +++ b/docs/man/man1/oc-adm-groups-sync.1 @@ -16,13 +16,7 @@ oc adm groups sync \- Sync OpenShift groups with records from an external provid Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wishto sync and where their records live. For instance, all or some groups may be selected from the current Groupsstored in OpenShift that have been synced previously, or similarly all or some groups may be selected from thosestored on an LDAP server. The path to a sync configuration file is required in order to describe how data isrequested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-runwithout changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by theLDAP query templates. .SH OPTIONS @@ -152,20 +146,19 @@ LDAP query templates. .nf # Sync all groups from an LDAP server oc adm groups sync \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server oc adm groups sync \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific groups specified in a whitelist file with an LDAP server oc adm groups sync \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server oc adm groups sync \-\-type=openshift \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server oc adm groups sync groups/group1 groups/group2 groups/group3 \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/oc-adm-ipfailover.1 b/docs/man/man1/oc-adm-ipfailover.1 index c25132502020..64e4c9a8c307 100644 --- a/docs/man/man1/oc-adm-ipfailover.1 +++ b/docs/man/man1/oc-adm-ipfailover.1 @@ -16,17 +16,10 @@ oc adm ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for thecluster. An administrator can configure IP failover on an entirecluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name,the \-\-create flag can be passed to create a deployment configuration thatwill provide IP failover capability. If you are running in production, it isrecommended that the labeled selector for the nodes matches at least 2 nodesto ensure you have failover protection, and that you provide a \-\-replicas=value that matches the number of nodes for the given labeled selector. .SH OPTIONS @@ -164,18 +157,18 @@ value that matches the number of nodes for the given labeled selector. .nf # Check the default IP failover configuration ("ipfailover"): oc adm ipfailover - + # See what the IP failover configuration would look like if it is created: oc adm ipfailover \-o json - + # Create an IP failover configuration if it does not already exist: oc adm ipfailover ipf \-\-virtual\-ips="10.1.1.1\-4" \-\-create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us\-west\-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). oc adm ipfailover ipfailover \-\-selector="router=us\-west\-ha" \-\-virtual\-ips="1.2.3.4,10.1.1.100\-104,5.6.7.8" \-\-watch\-port=80 \-\-replicas=4 \-\-create - + # Use a different IP failover config image and see the configuration: oc adm ipfailover ipf\-alt \-\-selector="hagroup=us\-west\-ha" \-\-virtual\-ips="1.2.3.4" \-o yaml \-\-images=myrepo/myipfailover:mytag diff --git a/docs/man/man1/oc-adm-manage-node.1 b/docs/man/man1/oc-adm-manage-node.1 index 86913ff2640f..52fb90e98e2c 100644 --- a/docs/man/man1/oc-adm-manage-node.1 +++ b/docs/man/man1/oc-adm-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node andmarking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - oc adm manage\-node \-\-schedulable=false - - # Mark selected nodes as schedulable - oc adm manage\-node \-\-selector="" \-\-schedulable=true - - # Migrate selected pods - oc adm manage\-node \-\-evacuate \-\-pod\-selector="" - - # Migrate selected pods, use a grace period of 60 seconds - oc adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - - # Migrate selected pods not backed by replication controller - oc adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - - # Show pods that will be migrated - oc adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - - # List all pods on given nodes - oc adm manage\-node \-\-list\-pods + # Block accepting any pods on given nodes + oc adm manage\-node \-\-schedulable=false + + # Mark selected nodes as schedulable + oc adm manage\-node \-\-selector="" \-\-schedulable=true + + # Migrate selected pods + oc adm manage\-node \-\-evacuate \-\-pod\-selector="" + + # Migrate selected pods, use a grace period of 60 seconds + oc adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + + # Migrate selected pods not backed by replication controller + oc adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + + # Show pods that will be migrated + oc adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + + # List all pods on given nodes + oc adm manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/oc-adm-migrate-image-references.1 b/docs/man/man1/oc-adm-migrate-image-references.1 index 14386716628a..3bb97f333c35 100644 --- a/docs/man/man1/oc-adm-migrate-image-references.1 +++ b/docs/man/man1/oc-adm-migrate-image-references.1 @@ -16,34 +16,35 @@ oc adm migrate image\-references \- Update embedded Docker image references Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default itwill update image streams and images, and may be used to update resources with a pod template(deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and thedesired registry and name. Either name or registry can be set to '*' to change all values.The registry value "docker.io" is special and will handle any image reference that refers tothe DockerHub. You may pass multiple mappings \- the first matching mapping will be appliedper resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs .IP -\(bu imagestreams * jobs +\(bu daemonsets .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs .IP -\(bu deploymentconfigs * pods +\(bu images +.IP +\(bu imagestreams +.IP +\(bu jobs +.IP +\(bu pods +.IP +\(bu replicationcontrollers .IP \(bu secrets (docker) .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and imagestreams requires administrative privileges. .SH OPTIONS @@ -149,16 +150,16 @@ streams requires administrative privileges. .nf # Perform a dry\-run of migrating all "docker.io" references to "myregistry.com" oc adm migrate image\-references docker.io/*=myregistry.com/* - + # To actually perform the migration, the confirm flag must be appended oc adm migrate image\-references docker.io/*=myregistry.com/* \-\-confirm - + # To see more details of what will be migrated, use the loglevel and output flags oc adm migrate image\-references docker.io/*=myregistry.com/* \-\-loglevel=2 \-o yaml - + # Migrate from a service IP to an internal service DNS name oc adm migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* - + # Migrate from a service IP to an internal service DNS name for all deployment configs and builds oc adm migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* \-\-include=buildconfigs,deploymentconfigs diff --git a/docs/man/man1/oc-adm-migrate-storage.1 b/docs/man/man1/oc-adm-migrate-storage.1 index 551b586e541b..39886f41a19c 100644 --- a/docs/man/man1/oc-adm-migrate-storage.1 +++ b/docs/man/man1/oc-adm-migrate-storage.1 @@ -16,25 +16,16 @@ oc adm migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forcesthe server to write to the underlying storage if the object representation has changed. Use thiscommand to ensure that the most recent storage changes have been applied to all objects (storageversion, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a runthe command will output a list of resources that received errors, which you can then re\-run thecommand on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource namesto operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scopedresources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If youhave significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may alsoresult in significant intra\-cluster traffic. .SH OPTIONS @@ -140,17 +131,16 @@ WARNING: This is a slow command and will put significant load on an API server. .nf # Perform a dry\-run of updating all objects oc adm migrate storage - + # To actually perform the update, the confirm flag must be appended oc adm migrate storage \-\-confirm - + # Only migrate pods oc adm migrate storage \-\-include=pods \-\-confirm - + # Only pods that are in namespaces starting with "bar" oc adm migrate storage \-\-include=pods \-\-confirm \-\-from\-key=bar/ \-\-to\-key=bar/\\xFF - .fi .RE diff --git a/docs/man/man1/oc-adm-new-project.1 b/docs/man/man1/oc-adm-new-project.1 index 2747db826a90..d4e12ee8d13d 100644 --- a/docs/man/man1/oc-adm-new-project.1 +++ b/docs/man/man1/oc-adm-new-project.1 @@ -16,9 +16,7 @@ oc adm new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project,an admin user (and role, if you want to use a non\-default admin role), and a node selectorto restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/oc-adm-pod-network-isolate-projects.1 b/docs/man/man1/oc-adm-pod-network-isolate-projects.1 index 4fbb2939050e..e5a5d5fb111d 100644 --- a/docs/man/man1/oc-adm-pod-network-isolate-projects.1 +++ b/docs/man/man1/oc-adm-pod-network-isolate-projects.1 @@ -96,11 +96,11 @@ Allows projects to isolate their network from other projects when using the redh .RS .nf - # Provide isolation for project p1 - oc adm pod\-network isolate\-projects - - # Allow all projects with label name=top\-secret to have their own isolated project network - oc adm pod\-network isolate\-projects \-\-selector='name=top\-secret' + # Provide isolation for project p1 + oc adm pod\-network isolate\-projects + + # Allow all projects with label name=top\-secret to have their own isolated project network + oc adm pod\-network isolate\-projects \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/oc-adm-pod-network-join-projects.1 b/docs/man/man1/oc-adm-pod-network-join-projects.1 index 406ecbfa48c7..dcb8b59c8d02 100644 --- a/docs/man/man1/oc-adm-pod-network-join-projects.1 +++ b/docs/man/man1/oc-adm-pod-network-join-projects.1 @@ -100,11 +100,11 @@ Allows projects to join existing project network when using the redhat/openshift .RS .nf - # Allow project p2 to use project p1 network - oc adm pod\-network join\-projects \-\-to= - - # Allow all projects with label name=top\-secret to use project p1 network - oc adm pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' + # Allow project p2 to use project p1 network + oc adm pod\-network join\-projects \-\-to= + + # Allow all projects with label name=top\-secret to use project p1 network + oc adm pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/oc-adm-pod-network-make-projects-global.1 b/docs/man/man1/oc-adm-pod-network-make-projects-global.1 index 4dd0056bb9e4..733aaafbd80b 100644 --- a/docs/man/man1/oc-adm-pod-network-make-projects-global.1 +++ b/docs/man/man1/oc-adm-pod-network-make-projects-global.1 @@ -96,11 +96,11 @@ Allows projects to access all pods in the cluster and vice versa when using the .RS .nf - # Allow project p1 to access all pods in the cluster and vice versa - oc adm pod\-network make\-projects\-global - - # Allow all projects with label name=share to access all pods in the cluster and vice versa - oc adm pod\-network make\-projects\-global \-\-selector='name=share' + # Allow project p1 to access all pods in the cluster and vice versa + oc adm pod\-network make\-projects\-global + + # Allow all projects with label name=share to access all pods in the cluster and vice versa + oc adm pod\-network make\-projects\-global \-\-selector='name=share' .fi .RE diff --git a/docs/man/man1/oc-adm-policy-add-role-to-user.1 b/docs/man/man1/oc-adm-policy-add-role-to-user.1 index 4cab11cfea4b..55ea25213d27 100644 --- a/docs/man/man1/oc-adm-policy-add-role-to-user.1 +++ b/docs/man/man1/oc-adm-policy-add-role-to-user.1 @@ -99,7 +99,7 @@ Add a role to users or serviceaccounts for the current project .nf # Add the 'view' role to user1 for the current project oc adm policy add\-role\-to\-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project oc adm policy add\-role\-to\-user edit \-z serviceaccount1 diff --git a/docs/man/man1/oc-adm-policy-add-scc-to-user.1 b/docs/man/man1/oc-adm-policy-add-scc-to-user.1 index 4d38141d3c05..c38f5933075e 100644 --- a/docs/man/man1/oc-adm-policy-add-scc-to-user.1 +++ b/docs/man/man1/oc-adm-policy-add-scc-to-user.1 @@ -95,7 +95,7 @@ Add users or serviceaccount to a security context constraint .nf # Add the 'restricted' security context contraint to user1 and user2 oc adm policy add\-scc\-to\-user restricted user1 user2 - + # Add the 'privileged' security context contraint to the service account serviceaccount1 in the current namespace oc adm policy add\-scc\-to\-user privileged \-z serviceaccount1 diff --git a/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 index 520aae620b6c..03311dbc305b 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ oc adm policy reconcile\-cluster\-role\-bindings \- Update cluster role bindings Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy.Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding.This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. @@ -147,16 +145,16 @@ You can see which recommended cluster role bindings have changed by choosing an .nf # Display the names of cluster role bindings that would be modified oc adm policy reconcile\-cluster\-role\-bindings \-o name - + # Display the cluster role bindings that would be modified, removing any extra subjects oc adm policy reconcile\-cluster\-role\-bindings \-\-additive\-only=false - + # Update cluster role bindings that don't match the current defaults oc adm policy reconcile\-cluster\-role\-bindings \-\-confirm - + # Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group oc adm policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-exclude\-groups=system:authenticated - + # Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding oc adm policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-additive\-only=false diff --git a/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 b/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 index 0113ab4135c7..843695c1299e 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ oc adm policy reconcile\-cluster\-roles \- Update cluster roles to match the rec Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster rolethat does not match will be replaced by the recommended bootstrap role. This command will not removeany additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. @@ -142,14 +140,14 @@ You can see which cluster roles have recommended changed by choosing an output t .nf # Display the names of cluster roles that would be modified oc adm policy reconcile\-cluster\-roles \-o name - + # Add missing permissions to cluster roles that don't match the current defaults oc adm policy reconcile\-cluster\-roles \-\-confirm - + # Add missing permissions and remove extra permissions from # cluster roles that don't match the current defaults oc adm policy reconcile\-cluster\-roles \-\-additive\-only=false \-\-confirm - + # Display the union of the default and modified cluster roles oc adm policy reconcile\-cluster\-roles \-\-additive\-only diff --git a/docs/man/man1/oc-adm-policy-reconcile-sccs.1 b/docs/man/man1/oc-adm-policy-reconcile-sccs.1 index 0b6632728617..51e8e5d3e044 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-sccs.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ oc adm policy reconcile\-sccs \- Replace cluster SCCs to match the recommended b Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs.Any cluster SCC that does not match will be replaced by the recommended SCC.This command will not remove any additional cluster SCCs. By default, this commandwill not remove additional users and groups that have been granted access to the SCC andwill preserve existing priorities (but will always reconcile unset priorities and the policydefinition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. @@ -146,11 +141,11 @@ You can see which cluster SCCs have recommended changes by choosing an output ty .nf # Display the cluster SCCs that would be modified oc adm policy reconcile\-sccs - + # Update cluster SCCs that don't match the current defaults preserving additional grants # for users and group and keeping any priorities that are already set oc adm policy reconcile\-sccs \-\-confirm - + # Replace existing users, groups, and priorities that do not match defaults oc adm policy reconcile\-sccs \-\-additive\-only=false \-\-confirm diff --git a/docs/man/man1/oc-adm-policy.1 b/docs/man/man1/oc-adm-policy.1 index c250a5baf9ea..1debe555910f 100644 --- a/docs/man/man1/oc-adm-policy.1 +++ b/docs/man/man1/oc-adm-policy.1 @@ -16,13 +16,10 @@ oc adm policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcilecommands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the followingresources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings',and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-prune-builds.1 b/docs/man/man1/oc-adm-prune-builds.1 index 9c60d213a193..9605c5304a2e 100644 --- a/docs/man/man1/oc-adm-prune-builds.1 +++ b/docs/man/man1/oc-adm-prune-builds.1 @@ -16,8 +16,7 @@ oc adm prune builds \- Remove old completed and failed builds Prune old completed and failed builds .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -116,7 +115,7 @@ By default, the prune operation performs a dry run making no changes to internal # Dry run deleting older completed and failed builds and also including # all builds whose associated BuildConfig no longer exists oc adm prune builds \-\-orphans - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune builds \-\-orphans \-\-confirm diff --git a/docs/man/man1/oc-adm-prune-deployments.1 b/docs/man/man1/oc-adm-prune-deployments.1 index 8d8b92083251..8f7b15b83963 100644 --- a/docs/man/man1/oc-adm-prune-deployments.1 +++ b/docs/man/man1/oc-adm-prune-deployments.1 @@ -16,8 +16,7 @@ oc adm prune deployments \- Remove old completed and failed deployments Prune old completed and failed deployments .PP -By default, the prune operation performs a dry run making no changes to the deployments. -A \-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to the deployments.A \-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -115,7 +114,7 @@ A \-\-confirm flag is needed for changes to be effective. .nf # Dry run deleting all but the last complete deployment for every deployment config oc adm prune deployments \-\-keep\-complete=1 - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune deployments \-\-keep\-complete=1 \-\-confirm diff --git a/docs/man/man1/oc-adm-prune-groups.1 b/docs/man/man1/oc-adm-prune-groups.1 index 5813d3ebb8e7..c7518a6b19ab 100644 --- a/docs/man/man1/oc-adm-prune-groups.1 +++ b/docs/man/man1/oc-adm-prune-groups.1 @@ -16,13 +16,7 @@ oc adm prune groups \- Prune OpenShift groups referencing missing records on an Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups oc adm prune groups \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file oc adm prune groups \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file oc adm prune groups \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist oc adm prune groups groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/oc-adm-prune-images.1 b/docs/man/man1/oc-adm-prune-images.1 index 4dee27112858..c5c2df8b9e11 100644 --- a/docs/man/man1/oc-adm-prune-images.1 +++ b/docs/man/man1/oc-adm-prune-images.1 @@ -16,12 +16,10 @@ oc adm prune images \- Remove unreferenced images Prune images no longer needed due to age and/or status .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .PP -Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete the -images. +Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete theimages. .SH OPTIONS @@ -120,14 +118,14 @@ images. # See, what the prune command would delete if only images more than an hour old and obsoleted # by 3 newer revisions under the same tag were considered. oc adm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm - + # See, what the prune command would delete if we're interested in removing images # exceeding currently set LimitRanges ('openshift.io/Image') oc adm prune images \-\-prune\-over\-size\-limit - + # To actually perform the prune operation, the confirm flag must be appended oc adm prune images \-\-prune\-over\-size\-limit \-\-confirm diff --git a/docs/man/man1/oc-adm-prune.1 b/docs/man/man1/oc-adm-prune.1 index a43671d35db2..b8c831071377 100644 --- a/docs/man/man1/oc-adm-prune.1 +++ b/docs/man/man1/oc-adm-prune.1 @@ -16,8 +16,7 @@ oc adm prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources onthe system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-registry.1 b/docs/man/man1/oc-adm-registry.1 index d054cb331e3f..352ede55b09e 100644 --- a/docs/man/man1/oc-adm-registry.1 +++ b/docs/man/man1/oc-adm-registry.1 @@ -16,28 +16,16 @@ oc adm registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications whenimages are pushed. With no arguments, the command will check for the existing registry servicecalled 'docker\-registry' and try to create it. If you want to test whether the registry hasbeen created add the \-\-dry\-run flag and the command will exit with 1 if the registry does notexist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like anobject store (several are supported by the Docker registry). The default Docker registry imageis configured to accept configuration as environment variables \- refer to the configuration file inthat image for more on setting up alternative storage. Once you've made those changes, you canpass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setupuses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will bechosen for use as the REGISTRYHTTPADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a newinstallation. Some configuration beyond this command is still required to makeyour registry persist data. .SH OPTIONS @@ -191,16 +179,16 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .nf # Check if default Docker registry ("docker\-registry") has been created oc adm registry \-\-dry\-run - + # See what the registry will look like if created oc adm registry \-o yaml - + # Create a registry with two replicas if it does not exist oc adm registry \-\-replicas=2 - + # Use a different registry image oc adm registry \-\-images=myrepo/docker\-registry:mytag - + # Enforce quota and limits on images oc adm registry \-\-enforce\-quota diff --git a/docs/man/man1/oc-adm-router.1 b/docs/man/man1/oc-adm-router.1 index 44a76af4c07d..7c5ff7fefb6f 100644 --- a/docs/man/man1/oc-adm-router.1 +++ b/docs/man/man1/oc-adm-router.1 @@ -16,17 +16,10 @@ oc adm router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it toyour application. With no arguments, the command will check for an existing routerservice called 'router' and create one if it does not exist. If you want to test whethera router has already been created add the \-\-dry\-run flag and the command will exit with1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command willcreate a deployment configuration and service that will run the router. If you arerunning your router in production, you should pass \-\-replicas=2 or higher to ensureyou have failover protection. .SH OPTIONS @@ -232,19 +225,18 @@ you have failover protection. .nf # Check the default router ("router") oc adm router \-\-dry\-run - + # See what the router would look like if created oc adm router \-o yaml - + # Create a router with two replicas if it does not exist oc adm router router\-west \-\-replicas=2 - + # Use a different router image oc adm router region\-west \-\-images=myrepo/somerouter:mytag - + # Run the router with a hint to the underlying implementation to \_not\_ expose statistics. oc adm router router\-west \-\-stats\-port=0 - .fi .RE diff --git a/docs/man/man1/oc-adm-taint.1 b/docs/man/man1/oc-adm-taint.1 index e98bd2f3e6ad..caaa78a67506 100644 --- a/docs/man/man1/oc-adm-taint.1 +++ b/docs/man/man1/oc-adm-taint.1 @@ -16,11 +16,7 @@ oc adm taint \- Update the taints on one or more nodes Update the taints on one or more nodes. .PP -A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. -The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The effect must be NoSchedule or PreferNoSchedule. -Currently taint can only apply to node. +A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The effect must be NoSchedule or PreferNoSchedule.Currently taint can only apply to node. .SH OPTIONS @@ -152,16 +148,15 @@ Currently taint can only apply to node. .RS .nf - -# Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. -# If a taint with that key and effect already exists, its value is replaced as specified. -oc adm taint nodes foo dedicated=special\-user:NoSchedule - -# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. -oc adm taint nodes foo dedicated:NoSchedule\- - -# Remove from node 'foo' all the taints with key 'dedicated' -oc adm taint nodes foo dedicated\- + # Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. + # If a taint with that key and effect already exists, its value is replaced as specified. + oc adm taint nodes foo dedicated=special\-user:NoSchedule + + # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. + oc adm taint nodes foo dedicated:NoSchedule\- + + # Remove from node 'foo' all the taints with key 'dedicated' + oc adm taint nodes foo dedicated\- .fi .RE diff --git a/docs/man/man1/oc-adm-top-images.1 b/docs/man/man1/oc-adm-top-images.1 index dcb5c37330a3..7ff0f41319ba 100644 --- a/docs/man/man1/oc-adm-top-images.1 +++ b/docs/man/man1/oc-adm-top-images.1 @@ -16,8 +16,7 @@ oc adm top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-top-imagestreams.1 b/docs/man/man1/oc-adm-top-imagestreams.1 index bf8e9834fe2d..aa1932bfd1c7 100644 --- a/docs/man/man1/oc-adm-top-imagestreams.1 +++ b/docs/man/man1/oc-adm-top-imagestreams.1 @@ -16,8 +16,7 @@ oc adm top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-top-node.1 b/docs/man/man1/oc-adm-top-node.1 index a6ece3d00d2a..6ecd94cbaa57 100644 --- a/docs/man/man1/oc-adm-top-node.1 +++ b/docs/man/man1/oc-adm-top-node.1 @@ -96,12 +96,11 @@ The top\-node command allows you to see the resource consumption of nodes. .RS .nf - -# Show metrics for all nodes -kubectl top node - -# Show metrics for a given node -kubectl top node NODE\_NAME + # Show metrics for all nodes + kubectl top node + + # Show metrics for a given node + kubectl top node NODE\_NAME .fi .RE diff --git a/docs/man/man1/oc-adm-top-pod.1 b/docs/man/man1/oc-adm-top-pod.1 index 9b0271ce2aa3..b9fc96f0e71d 100644 --- a/docs/man/man1/oc-adm-top-pod.1 +++ b/docs/man/man1/oc-adm-top-pod.1 @@ -19,8 +19,7 @@ Display Resource (CPU/Memory/Storage) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. .PP -Due to the metrics pipeline delay, they may be unavailable for a few minutes -since pod creation. +Due to the metrics pipeline delay, they may be unavailable for a few minutessince pod creation. .SH OPTIONS @@ -108,18 +107,17 @@ since pod creation. .RS .nf - -# Show metrics for all pods in the default namespace -kubectl top pod - -# Show metrics for all pods in the given namespace -kubectl top pod \-\-namespace=NAMESPACE - -# Show metrics for a given pod and its containers -kubectl top pod POD\_NAME \-\-containers - -# Show metrics for the pods defined by label name=myLabel -kubectl top pod \-l name=myLabel + # Show metrics for all pods in the default namespace + kubectl top pod + + # Show metrics for all pods in the given namespace + kubectl top pod \-\-namespace=NAMESPACE + + # Show metrics for a given pod and its containers + kubectl top pod POD\_NAME \-\-containers + + # Show metrics for the pods defined by label name=myLabel + kubectl top pod \-l name=myLabel .fi .RE diff --git a/docs/man/man1/oc-adm-top.1 b/docs/man/man1/oc-adm-top.1 index 98a374a6ca78..7c8cc21323e8 100644 --- a/docs/man/man1/oc-adm-top.1 +++ b/docs/man/man1/oc-adm-top.1 @@ -16,8 +16,7 @@ oc adm top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-adm-uncordon.1 b/docs/man/man1/oc-adm-uncordon.1 index e5509f17b024..3584bb62e1f8 100644 --- a/docs/man/man1/oc-adm-uncordon.1 +++ b/docs/man/man1/oc-adm-uncordon.1 @@ -87,10 +87,8 @@ Mark node as schedulable. .RS .nf - -# Mark node "foo" as schedulable. -$ oc adm uncordon foo - + # Mark node "foo" as schedulable. + $ oc adm uncordon foo .fi .RE diff --git a/docs/man/man1/oc-adm.1 b/docs/man/man1/oc-adm.1 index 7ca38b3abd98..089fbfa1a007 100644 --- a/docs/man/man1/oc-adm.1 +++ b/docs/man/man1/oc-adm.1 @@ -16,8 +16,7 @@ oc adm \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrativeactions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/oc-annotate.1 b/docs/man/man1/oc-annotate.1 index 3fae4d9062cb..9e2d89bb0efa 100644 --- a/docs/man/man1/oc-annotate.1 +++ b/docs/man/man1/oc-annotate.1 @@ -16,13 +16,7 @@ oc annotate \- Update the annotations on a resource Update the annotations on one or more resources .PP -An annotation is a key/value pair that can hold larger (compared to a label), -and possibly not human\-readable, data. It is intended to store non\-identifying -auxiliary data, especially data manipulated by tools and system extensions. If -\-\-overwrite is true, then existing annotations can be overwritten, otherwise -attempting to overwrite an annotation will result in an error. If -\-\-resource\-version is specified, then updates will use this resource version, -otherwise the existing resource\-version will be used. +An annotation is a key/value pair that can hold larger (compared to a label),and possibly not human\-readable, data. It is intended to store non\-identifyingauxiliary data, especially data manipulated by tools and system extensions. If\-\-overwrite is true, then existing annotations can be overwritten, otherwiseattempting to overwrite an annotation will result in an error. If\-\-resource\-version is specified, then updates will use this resource version,otherwise the existing resource\-version will be used. .PP Run 'oc types' for a list of valid resources. @@ -168,17 +162,17 @@ Run 'oc types' for a list of valid resources. # Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied oc annotate pods foo description='my frontend' - + # Update pod 'foo' with the annotation 'description' and the value # 'my frontend running nginx', overwriting any existing value. oc annotate \-\-overwrite pods foo description='my frontend running nginx' - + # Update all pods in the namespace oc annotate pods \-\-all description='my frontend running nginx' - + # Update pod 'foo' only if the resource is unchanged from version 1. oc annotate pods foo description='my frontend running nginx' \-\-resource\-version=1 - + # Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the \-\-overwrite flag. oc annotate pods foo description\- diff --git a/docs/man/man1/oc-apply.1 b/docs/man/man1/oc-apply.1 index 2f7e83e0bbea..58f5be181fe9 100644 --- a/docs/man/man1/oc-apply.1 +++ b/docs/man/man1/oc-apply.1 @@ -124,11 +124,11 @@ JSON and YAML formats are accepted. .RS .nf -# Apply the configuration in pod.json to a pod. -oc apply \-f ./pod.json - -# Apply the JSON passed into stdin to a pod. -cat pod.json | oc apply \-f \- + # Apply the configuration in pod.json to a pod. + oc apply \-f ./pod.json + + # Apply the JSON passed into stdin to a pod. + cat pod.json | oc apply \-f \- .fi .RE diff --git a/docs/man/man1/oc-attach.1 b/docs/man/man1/oc-attach.1 index c57139aece9e..afa261d4b1f6 100644 --- a/docs/man/man1/oc-attach.1 +++ b/docs/man/man1/oc-attach.1 @@ -16,8 +16,7 @@ oc attach \- Attach to a running container Attach to a running container .PP -Attach the current shell to a remote container, returning output or setting up a full -terminal session. Can be used to debug containers and invoke interactive commands. +Attach the current shell to a remote container, returning output or setting up a fullterminal session. Can be used to debug containers and invoke interactive commands. .SH OPTIONS @@ -107,10 +106,10 @@ terminal session. Can be used to debug containers and invoke interactive command .nf # Get output from running pod 123456\-7890, using the first container by default oc attach 123456\-7890 - + # Get output from ruby\-container from pod 123456\-7890 oc attach 123456\-7890 \-c ruby\-container - + # Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 # and sends stdout/stderr from 'bash' back to the client oc attach 123456\-7890 \-c ruby\-container \-i \-t diff --git a/docs/man/man1/oc-autoscale.1 b/docs/man/man1/oc-autoscale.1 index afa3c4a65314..479518c78a16 100644 --- a/docs/man/man1/oc-autoscale.1 +++ b/docs/man/man1/oc-autoscale.1 @@ -16,9 +16,7 @@ oc autoscale \- Autoscale a deployment config or replication controller Autoscale a deployment config or replication controller. .PP -Looks up a deployment config or replication controller by name and creates an autoscaler that uses -this deployment config or replication controller as a reference. An autoscaler can automatically -increase or decrease number of pods deployed within the system as needed. +Looks up a deployment config or replication controller by name and creates an autoscaler that usesthis deployment config or replication controller as a reference. An autoscaler can automaticallyincrease or decrease number of pods deployed within the system as needed. .SH OPTIONS @@ -170,10 +168,12 @@ increase or decrease number of pods deployed within the system as needed. .RS .nf - # Auto scale a deployment config "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: + # Auto scale a deployment config "foo", with the number of pods between 2 to + # 10, target CPU utilization at a default value that server applies: oc autoscale dc/foo \-\-min=2 \-\-max=10 - - # Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80% + + # Auto scale a replication controller "foo", with the number of pods between + # 1 to 5, target CPU utilization at 80% oc autoscale rc/foo \-\-max=5 \-\-cpu\-percent=80 .fi diff --git a/docs/man/man1/oc-cancel-build.1 b/docs/man/man1/oc-cancel-build.1 index 3fcd017c26a8..6b79d4dd5cf8 100644 --- a/docs/man/man1/oc-cancel-build.1 +++ b/docs/man/man1/oc-cancel-build.1 @@ -16,8 +16,7 @@ oc cancel\-build \- Cancel running, pending, or new builds Cancel running, pending, or new builds .PP -This command requests a graceful shutdown of the build. There may be a delay between requesting -the build and the time the build is terminated. +This command requests a graceful shutdown of the build. There may be a delay between requestingthe build and the time the build is terminated. .SH OPTIONS @@ -107,16 +106,16 @@ the build and the time the build is terminated. .nf # Cancel the build with the given name oc cancel\-build ruby\-build\-2 - + # Cancel the named build and print the build logs oc cancel\-build ruby\-build\-2 \-\-dump\-logs - + # Cancel the named build and create a new one with the same parameters oc cancel\-build ruby\-build\-2 \-\-restart - + # Cancel multiple builds oc cancel\-build ruby\-build\-1 ruby\-build\-2 ruby\-build\-3 - + # Cancel all builds created from 'ruby\-build' build configuration that are in 'new' state oc cancel\-build bc/ruby\-build \-\-state=new diff --git a/docs/man/man1/oc-cluster-down.1 b/docs/man/man1/oc-cluster-down.1 index dea3483871bc..b35bf574cd5a 100644 --- a/docs/man/man1/oc-cluster-down.1 +++ b/docs/man/man1/oc-cluster-down.1 @@ -16,8 +16,7 @@ oc cluster down \- Stop OpenShift on Docker Stops the container running OpenShift on Docker and associated containers. .PP -If you started your OpenShift with a specific docker\-machine, you need to specify the -same machine using the \-\-docker\-machine argument. +If you started your OpenShift with a specific docker\-machine, you need to specify thesame machine using the \-\-docker\-machine argument. .SH OPTIONS @@ -97,14 +96,12 @@ same machine using the \-\-docker\-machine argument. .RS .nf - # Stop local Docker cluster oc cluster down - + # Stop cluster running on Docker machine 'mymachine' oc cluster down \-\-docker\-machine=mymachine - .fi .RE diff --git a/docs/man/man1/oc-cluster-up.1 b/docs/man/man1/oc-cluster-up.1 index 5dbd1b44b342..10952c5754f2 100644 --- a/docs/man/man1/oc-cluster-up.1 +++ b/docs/man/man1/oc-cluster-up.1 @@ -13,24 +13,16 @@ oc cluster up \- Start OpenShift on Docker with reasonable defaults .SH DESCRIPTION .PP -Starts an OpenShift cluster using Docker containers, provisioning a registry, router, -initial templates, and a default project. +Starts an OpenShift cluster using Docker containers, provisioning a registry, router,initial templates, and a default project. .PP -This command will attempt to use an existing connection to a Docker daemon. Before running -the command, ensure that you can execure docker commands successfully (ie. 'docker ps'). +This command will attempt to use an existing connection to a Docker daemon. Before runningthe command, ensure that you can execure docker commands successfully (ie. 'docker ps'). .PP -Optionally, the command can create a new Docker machine for OpenShift using the VirtualBox -driver when the \-\-create\-machine argument is specified. The machine will be named 'openshift' -by default. To name the machine differently, use the \-\-docker\-machine=NAME argument. If the -\-\-docker\-machine=NAME argument is specified, but \-\-create\-machine is not, the command will attempt -to find an existing docker machine with that name and start it if it's not running. +Optionally, the command can create a new Docker machine for OpenShift using the VirtualBoxdriver when the \-\-create\-machine argument is specified. The machine will be named 'openshift'by default. To name the machine differently, use the \-\-docker\-machine=NAME argument. If the\-\-docker\-machine=NAME argument is specified, but \-\-create\-machine is not, the command will attemptto find an existing docker machine with that name and start it if it's not running. .PP -By default, the OpenShift cluster will be setup to use a routing suffix that ends in xip.io. -This is to allow dynamic host names to be created for routes. An alternate routing suffix -can be specified using the \-\-routing\-suffix flag. +By default, the OpenShift cluster will be setup to use a routing suffix that ends in xip.io.This is to allow dynamic host names to be created for routes. An alternate routing suffixcan be specified using the \-\-routing\-suffix flag. .PP A public hostname can also be specified for the server with the \-\-public\-hostname flag. @@ -169,20 +161,18 @@ A public hostname can also be specified for the server with the \-\-public\-host .RS .nf - # Start OpenShift on a new docker machine named 'openshift' oc cluster up \-\-create\-machine - + # Start OpenShift using a specific public host name oc cluster up \-\-public\-hostname=my.address.example.com - + # Start OpenShift and preserve data and config between restarts oc cluster up \-\-host\-data\-dir=/mydata \-\-use\-existing\-config - + # Use a different set of images oc cluster up \-\-image="registry.example.com/origin" \-\-version="v1.1" - .fi .RE diff --git a/docs/man/man1/oc-cluster.1 b/docs/man/man1/oc-cluster.1 index dfdaddf97e47..6490fc35c084 100644 --- a/docs/man/man1/oc-cluster.1 +++ b/docs/man/man1/oc-cluster.1 @@ -13,25 +13,19 @@ oc cluster \- Start and stop OpenShift cluster .SH DESCRIPTION .PP -Manage a local OpenShift cluster. +Manage a local OpenShift cluster .PP -The OpenShift cluster will run as an all\-in\-one container on a Docker host. The Docker host -may be a local VM (ie. using docker\-machine on OS X and Windows clients), remote machine, or -the local Unix host. +The OpenShift cluster will run as an all\-in\-one container on a Docker host. The Docker hostmay be a local VM (ie. using docker\-machine on OS X and Windows clients), remote machine, orthe local Unix host. .PP -To use an existing Docker connection, ensure that Docker commands are working and that you -can create new containers. For OS X and Windows clients, a docker\-machine with the VirtualBox -driver can be created for you using the \-\-create\-machine option. +To use an existing Docker connection, ensure that Docker commands are working and that youcan create new containers. For OS X and Windows clients, a docker\-machine with the VirtualBoxdriver can be created for you using the \-\-create\-machine option. .PP -By default, etcd data will not be preserved between container restarts. If you wish to -preserve your data, specify a value for \-\-host\-data\-dir and the \-\-use\-existing\-config flag. +By default, etcd data will not be preserved between container restarts. If you wish topreserve your data, specify a value for \-\-host\-data\-dir and the \-\-use\-existing\-config flag. .PP -Default routes are setup using xip.io and the host ip of your cluster. To use a different -routing suffix, use the \-\-routing\-suffix flag. +Default routes are setup using xip.io and the host ip of your cluster. To use a differentrouting suffix, use the \-\-routing\-suffix flag. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-completion.1 b/docs/man/man1/oc-completion.1 index 447509d60df6..c9cf91045782 100644 --- a/docs/man/man1/oc-completion.1 +++ b/docs/man/man1/oc-completion.1 @@ -13,8 +13,7 @@ oc completion \- Output shell completion code for the given shell (bash or zsh) .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of oc commands. +This command prints shell code which must be evaluated to provide interactivecompletion of oc commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -91,18 +90,19 @@ completion of oc commands. # Generate the oc completion code for bash oc completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion oc completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(oc completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/oc-config-current-context.1 b/docs/man/man1/oc-config-current-context.1 index 0d71b4e6aa5e..a3f201742c6f 100644 --- a/docs/man/man1/oc-config-current-context.1 +++ b/docs/man/man1/oc-config-current-context.1 @@ -87,7 +87,6 @@ Displays the current\-context .RS .nf - # Display the current\-context oc config current\-context diff --git a/docs/man/man1/oc-config-set-cluster.1 b/docs/man/man1/oc-config-set-cluster.1 index 1f565126b017..1cd3705639d2 100644 --- a/docs/man/man1/oc-config-set-cluster.1 +++ b/docs/man/man1/oc-config-set-cluster.1 @@ -13,8 +13,7 @@ oc config set\-cluster \- Sets a cluster entry in kubeconfig .SH DESCRIPTION .PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set only the server field on the e2e cluster entry without touching other values. oc config set\-cluster e2e \-\-server=https://1.2.3.4 diff --git a/docs/man/man1/oc-config-set-context.1 b/docs/man/man1/oc-config-set-context.1 index aebd7b3c9845..6fac9b811dd5 100644 --- a/docs/man/man1/oc-config-set-context.1 +++ b/docs/man/man1/oc-config-set-context.1 @@ -13,8 +13,7 @@ oc config set\-context \- Sets a context entry in kubeconfig .SH DESCRIPTION .PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set the user field on the gce context entry without touching other values oc config set\-context gce \-\-user=cluster\-admin diff --git a/docs/man/man1/oc-config-set-credentials.1 b/docs/man/man1/oc-config-set-credentials.1 index be4f2005a40a..1e1e53f11364 100644 --- a/docs/man/man1/oc-config-set-credentials.1 +++ b/docs/man/man1/oc-config-set-credentials.1 @@ -13,20 +13,16 @@ oc config set\-credentials \- Sets a user entry in kubeconfig .SH DESCRIPTION .PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. +Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values. .PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile +Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile .PP -Bearer token flags: - \-\-token=bearer\_token +Bearer token flags:\-\-token=bearer\_token .PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password +Basic auth flags:\-\-username=basicuser \-\-password=basicpassword .PP Bearer token and basic auth are mutually exclusive. @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive. .RS .nf - # Set only the "client\-key" field on the "cluster\-admin" # entry, without touching other values: oc config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key diff --git a/docs/man/man1/oc-config-set.1 b/docs/man/man1/oc-config-set.1 index d20b49a7f81a..134767fe9bb7 100644 --- a/docs/man/man1/oc-config-set.1 +++ b/docs/man/man1/oc-config-set.1 @@ -13,9 +13,7 @@ oc config set \- Sets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. +Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. .SH OPTIONS diff --git a/docs/man/man1/oc-config-unset.1 b/docs/man/man1/oc-config-unset.1 index fb478b3430a9..b48c605764b0 100644 --- a/docs/man/man1/oc-config-unset.1 +++ b/docs/man/man1/oc-config-unset.1 @@ -13,8 +13,7 @@ oc config unset \- Unsets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. +Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-config-view.1 b/docs/man/man1/oc-config-view.1 index f71abde9fd4e..c94a017eb5d9 100644 --- a/docs/man/man1/oc-config-view.1 +++ b/docs/man/man1/oc-config-view.1 @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat .RS .nf - # Show Merged kubeconfig settings. oc config view diff --git a/docs/man/man1/oc-config.1 b/docs/man/man1/oc-config.1 index 17e8e11d90d9..bd53125d72ff 100644 --- a/docs/man/man1/oc-config.1 +++ b/docs/man/man1/oc-config.1 @@ -16,9 +16,7 @@ oc config \- Change configuration files for the client Manage the client config files .PP -The client stores configuration in the current user's home directory (under the .kube directory as -config). When you login the first time, a new config file is created, and subsequent project changes with the -'project' command will set the current context. These subcommands allow you to manage the config directly. +The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly. .PP Reference: diff --git a/docs/man/man1/oc-convert.1 b/docs/man/man1/oc-convert.1 index 21b9c98f9037..2ade9465a6b8 100644 --- a/docs/man/man1/oc-convert.1 +++ b/docs/man/man1/oc-convert.1 @@ -13,17 +13,13 @@ oc convert \- Convert config files between different API versions .SH DESCRIPTION .PP -Convert config files between different API versions. Both YAML -and JSON formats are accepted. +Convert config files between different API versions. Both YAMLand JSON formats are accepted. .PP -The command takes filename, directory, or URL as input, and convert it into format -of version specified by \-\-output\-version flag. If target version is not specified or -not supported, convert to latest version. +The command takes filename, directory, or URL as input, and convert it into formatof version specified by \-\-output\-version flag. If target version is not specified ornot supported, convert to latest version. .PP -The default output will be printed to stdout in YAML format. One can use \-o option -to change to output destination. +The default output will be printed to stdout in YAML format. One can use \-o optionto change to output destination. .SH OPTIONS @@ -157,15 +153,14 @@ to change to output destination. .nf # Convert 'pod.yaml' to latest version and print to stdout. oc convert \-f pod.yaml - + # Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in json format. oc convert \-f pod.yaml \-\-local \-o json - + # Convert all files under current directory to latest version and create them all. oc convert \-f . | oc create \-f \- - .fi .RE diff --git a/docs/man/man1/oc-create-configmap.1 b/docs/man/man1/oc-create-configmap.1 index ae19f7832f1e..2bc7558c1b8a 100644 --- a/docs/man/man1/oc-create-configmap.1 +++ b/docs/man/man1/oc-create-configmap.1 @@ -19,13 +19,10 @@ Create a configmap based on a file, directory, or specified literal value. A single configmap may package one or more key/value pairs. .PP -When creating a configmap based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. +When creating a configmap based on a file, the key will default to the basename of the file, and the value willdefault to the file content. If the basename is an invalid key, you may specify an alternate key. .PP -When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be -packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). +When creating a configmap based on a directory, each file whose basename is a valid key in the directory will bepackaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories,symlinks, devices, pipes, etc). .SH OPTIONS @@ -161,7 +158,6 @@ symlinks, devices, pipes, etc). .RS .nf - # Create a new configmap named my\-config with keys for each file in folder bar oc create configmap my\-config \-\-from\-file=path/to/bar diff --git a/docs/man/man1/oc-create-deployment.1 b/docs/man/man1/oc-create-deployment.1 index 201f8dd40549..ab2e4dd74f9d 100644 --- a/docs/man/man1/oc-create-deployment.1 +++ b/docs/man/man1/oc-create-deployment.1 @@ -145,7 +145,6 @@ Create a deployment with the specified name. .RS .nf - # Create a new deployment named my\-dep that runs the busybox image. oc create deployment my\-dep \-\-image=busybox diff --git a/docs/man/man1/oc-create-identity.1 b/docs/man/man1/oc-create-identity.1 index 737358e91169..793e7af982a1 100644 --- a/docs/man/man1/oc-create-identity.1 +++ b/docs/man/man1/oc-create-identity.1 @@ -16,13 +16,10 @@ oc create identity \- Manually create an identity (only needed if automatic crea This command can be used to create an identity object. .PP -Typically, identities are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), identities must -be created manually. +Typically, identities are created automatically during login. If automaticcreation is disabled (by using the "lookup" mapping method), identities mustbe created manually. .PP -Corresponding user and useridentitymapping objects must also be created -to allow logging in with the created identity. +Corresponding user and useridentitymapping objects must also be createdto allow logging in with the created identity. .SH OPTIONS diff --git a/docs/man/man1/oc-create-imagestream.1 b/docs/man/man1/oc-create-imagestream.1 index 2f05fc216c7a..6a39808eb874 100644 --- a/docs/man/man1/oc-create-imagestream.1 +++ b/docs/man/man1/oc-create-imagestream.1 @@ -16,8 +16,7 @@ oc create imagestream \- Create a new empty image stream. Create a new image stream .PP -Image streams allow you to track, tag, and import images from other registries. They also define an -access controlled destination that you can push images to. +Image streams allow you to track, tag, and import images from other registries. They also define anaccess controlled destination that you can push images to. .SH OPTIONS diff --git a/docs/man/man1/oc-create-namespace.1 b/docs/man/man1/oc-create-namespace.1 index 8f6c4e5901e3..d9a2585aa017 100644 --- a/docs/man/man1/oc-create-namespace.1 +++ b/docs/man/man1/oc-create-namespace.1 @@ -141,7 +141,6 @@ Create a namespace with the specified name. .RS .nf - # Create a new namespace named my\-namespace oc create namespace my\-namespace diff --git a/docs/man/man1/oc-create-route-edge.1 b/docs/man/man1/oc-create-route-edge.1 index d3d2a14444e8..ac772f1c3655 100644 --- a/docs/man/man1/oc-create-route-edge.1 +++ b/docs/man/man1/oc-create-route-edge.1 @@ -16,8 +16,7 @@ oc create route edge \- Create a route that uses edge TLS termination Create a route that uses edge TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that thegenerated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route-passthrough.1 b/docs/man/man1/oc-create-route-passthrough.1 index 92576636c3ed..0672419a12c8 100644 --- a/docs/man/man1/oc-create-route-passthrough.1 +++ b/docs/man/man1/oc-create-route-passthrough.1 @@ -16,8 +16,7 @@ oc create route passthrough \- Create a route that uses passthrough TLS terminat Create a route that uses passthrough TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that thegenerated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route-reencrypt.1 b/docs/man/man1/oc-create-route-reencrypt.1 index 7b4e433bf505..78b44ad84457 100644 --- a/docs/man/man1/oc-create-route-reencrypt.1 +++ b/docs/man/man1/oc-create-route-reencrypt.1 @@ -16,9 +16,7 @@ oc create route reencrypt \- Create a route that uses reencrypt TLS termination Create a route that uses reencrypt TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. A destination CA certificate -is needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. +Specify the service (either just its name or using type/name syntax) that thegenerated route should expose via the \-\-service flag. A destination CA certificateis needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. .SH OPTIONS diff --git a/docs/man/man1/oc-create-route.1 b/docs/man/man1/oc-create-route.1 index 66d7e0463868..f15688593ee0 100644 --- a/docs/man/man1/oc-create-route.1 +++ b/docs/man/man1/oc-create-route.1 @@ -16,8 +16,7 @@ oc create route \- Expose containers externally via secured routes Expose containers externally via secured routes .PP -Three types of secured routes are supported: edge, passthrough, and reencrypt. -If you wish to create unsecured routes, see "oc expose \-h" +Three types of secured routes are supported: edge, passthrough, and reencrypt.If you wish to create unsecured routes, see "oc expose \-h" .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-create-secret-docker-registry.1 b/docs/man/man1/oc-create-secret-docker-registry.1 index 5e1f3bfaa32e..4fb81ddf60cf 100644 --- a/docs/man/man1/oc-create-secret-docker-registry.1 +++ b/docs/man/man1/oc-create-secret-docker-registry.1 @@ -19,15 +19,10 @@ Create a new secret for use with Docker registries. Dockercfg secrets are used to authenticate against Docker registries. .PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. +When using the Docker command line to push images, you can authenticate to a given registry by running'docker login DOCKERREGISTRYSERVER \-\-username=DOCKERUSER \-\-password=DOCKERPASSWORD \-\-email=DOCKER\_EMAIL'.That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands toauthenticate to the registry. .PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. +When creating applications, you may have a Docker registry that requires authentication. In order for thenodes to pull images on your behalf, they have to have the credentials. You can provide this informationby creating a dockercfg secret and attaching it to your service account. .SH OPTIONS @@ -176,7 +171,6 @@ by creating a dockercfg secret and attaching it to your service account. .RS .nf - # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: oc create secret docker\-registry my\-secret \-\-docker\-server=DOCKER\_REGISTRY\_SERVER \-\-docker\-username=DOCKER\_USER \-\-docker\-password=DOCKER\_PASSWORD \-\-docker\-email=DOCKER\_EMAIL diff --git a/docs/man/man1/oc-create-secret-generic.1 b/docs/man/man1/oc-create-secret-generic.1 index 39fee5e9d6af..21213322b3ca 100644 --- a/docs/man/man1/oc-create-secret-generic.1 +++ b/docs/man/man1/oc-create-secret-generic.1 @@ -19,13 +19,10 @@ Create a secret based on a file, directory, or specified literal value. A single secret may package one or more key/value pairs. .PP -When creating a secret based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. +When creating a secret based on a file, the key will default to the basename of the file, and the value willdefault to the file content. If the basename is an invalid key, you may specify an alternate key. .PP -When creating a secret based on a directory, each file whose basename is a valid key in the directory will be -packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). +When creating a secret based on a directory, each file whose basename is a valid key in the directory will bepackaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories,symlinks, devices, pipes, etc). .SH OPTIONS @@ -165,7 +162,6 @@ symlinks, devices, pipes, etc). .RS .nf - # Create a new secret named my\-secret with keys for each file in folder bar oc create secret generic my\-secret \-\-from\-file=path/to/bar diff --git a/docs/man/man1/oc-create-secret-tls.1 b/docs/man/man1/oc-create-secret-tls.1 index cb9c1bdc431e..51133483846d 100644 --- a/docs/man/man1/oc-create-secret-tls.1 +++ b/docs/man/man1/oc-create-secret-tls.1 @@ -152,7 +152,6 @@ The public/private key pair must exist before hand. The public key certificate m .RS .nf - # Create a new TLS secret named tls\-secret with the given key pair: oc create secret tls tls\-secret \-\-cert=path/to/tls.cert \-\-key=path/to/tls.key diff --git a/docs/man/man1/oc-create-service-clusterip.1 b/docs/man/man1/oc-create-service-clusterip.1 index b9b394a1f089..4cdecc8e2b6d 100644 --- a/docs/man/man1/oc-create-service-clusterip.1 +++ b/docs/man/man1/oc-create-service-clusterip.1 @@ -149,7 +149,6 @@ Create a clusterIP service with the specified name. .RS .nf - # Create a new clusterIP service named my\-cs oc create service clusterip my\-cs \-\-tcp=5678:8080 diff --git a/docs/man/man1/oc-create-service-loadbalancer.1 b/docs/man/man1/oc-create-service-loadbalancer.1 index 5efb6135d041..e2f2b956b036 100644 --- a/docs/man/man1/oc-create-service-loadbalancer.1 +++ b/docs/man/man1/oc-create-service-loadbalancer.1 @@ -145,7 +145,6 @@ Create a LoadBalancer service with the specified name. .RS .nf - # Create a new nodeport service named my\-lbs oc create service loadbalancer my\-lbs \-\-tcp=5678:8080 diff --git a/docs/man/man1/oc-create-service-nodeport.1 b/docs/man/man1/oc-create-service-nodeport.1 index d851b6ed66e6..12ff7613a9c9 100644 --- a/docs/man/man1/oc-create-service-nodeport.1 +++ b/docs/man/man1/oc-create-service-nodeport.1 @@ -145,7 +145,6 @@ Create a nodeport service with the specified name. .RS .nf - # Create a new nodeport service named my\-ns oc create service nodeport my\-ns \-\-tcp=5678:8080 diff --git a/docs/man/man1/oc-create-serviceaccount.1 b/docs/man/man1/oc-create-serviceaccount.1 index bd097892d3c2..a003cd0812b4 100644 --- a/docs/man/man1/oc-create-serviceaccount.1 +++ b/docs/man/man1/oc-create-serviceaccount.1 @@ -145,7 +145,6 @@ Create a service account with the specified name. .RS .nf - # Create a new service account named my\-service\-account $ oc create serviceaccount my\-service\-account diff --git a/docs/man/man1/oc-create-user.1 b/docs/man/man1/oc-create-user.1 index 321c086a195c..3f00dd1c06c8 100644 --- a/docs/man/man1/oc-create-user.1 +++ b/docs/man/man1/oc-create-user.1 @@ -16,13 +16,10 @@ oc create user \- Manually create a user (only needed if automatic creation is d This command can be used to create a user object. .PP -Typically, users are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), users must -be created manually. +Typically, users are created automatically during login. If automaticcreation is disabled (by using the "lookup" mapping method), users mustbe created manually. .PP -Corresponding identity and useridentitymapping objects must also be created -to allow logging in as the created user. +Corresponding identity and useridentitymapping objects must also be createdto allow logging in as the created user. .SH OPTIONS diff --git a/docs/man/man1/oc-create-useridentitymapping.1 b/docs/man/man1/oc-create-useridentitymapping.1 index 25e63e98452d..1295877bdaf1 100644 --- a/docs/man/man1/oc-create-useridentitymapping.1 +++ b/docs/man/man1/oc-create-useridentitymapping.1 @@ -13,10 +13,7 @@ oc create useridentitymapping \- Manually map an identity to a user. .SH DESCRIPTION .PP -Typically, identities are automatically mapped to users during login. If automatic -mapping is disabled (by using the "lookup" mapping method), or a mapping needs to -be manually established between an identity and a user, this command can be used -to create a useridentitymapping object. +Typically, identities are automatically mapped to users during login. If automaticmapping is disabled (by using the "lookup" mapping method), or a mapping needs tobe manually established between an identity and a user, this command can be usedto create a useridentitymapping object. .SH OPTIONS diff --git a/docs/man/man1/oc-debug.1 b/docs/man/man1/oc-debug.1 index 703e32d71b9e..7dee13327dd4 100644 --- a/docs/man/man1/oc-debug.1 +++ b/docs/man/man1/oc-debug.1 @@ -16,27 +16,16 @@ oc debug \- Launch a new instance of a pod for debugging Launch a command shell to debug a running application .PP -When debugging images and setup problems, it's useful to get an exact copy of a running -pod configuration and troubleshoot with a shell. Since a pod that is failing may not be -started and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy to -create a carbon copy of that setup. +When debugging images and setup problems, it's useful to get an exact copy of a runningpod configuration and troubleshoot with a shell. Since a pod that is failing may not bestarted and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy tocreate a carbon copy of that setup. .PP -The default mode is to start a shell inside of the first container of the referenced pod, -replication controller, or deployment config. The started pod will be a copy of your -source pod, with labels stripped, the command changed to '/bin/sh', and readiness and -liveness checks disabled. If you just want to run a command, add '\-\-' and a command to -run. Passing a command will not create a TTY or send STDIN by default. Other flags are -supported for altering the container or pod in common ways. +The default mode is to start a shell inside of the first container of the referenced pod,replication controller, or deployment config. The started pod will be a copy of yoursource pod, with labels stripped, the command changed to '/bin/sh', and readiness andliveness checks disabled. If you just want to run a command, add '\-\-' and a command torun. Passing a command will not create a TTY or send STDIN by default. Other flags aresupported for altering the container or pod in common ways. .PP -A common problem running containers is a security policy that prohibits you from running -as a root user on the cluster. You can use this command to test running a pod as -non\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). +A common problem running containers is a security policy that prohibits you from runningas a root user on the cluster. You can use this command to test running a pod asnon\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). .PP -The debug pod is deleted when the the remote command completes or the user interrupts -the shell. +The debug pod is deleted when the the remote command completes or the user interruptsthe shell. .SH OPTIONS @@ -179,16 +168,15 @@ the shell. .RS .nf - # Debug a currently running deployment oc debug dc/test - + # Test running a deployment as a non\-root user oc debug dc/test \-\-as\-user=1000000 - + # Debug a specific failing container by running the env command in the 'second' container oc debug dc/test \-c second \-\- /bin/env - + # See the pod that would be created to debug oc debug dc/test \-o yaml diff --git a/docs/man/man1/oc-delete.1 b/docs/man/man1/oc-delete.1 index 87e2143414c8..4d86a179bf80 100644 --- a/docs/man/man1/oc-delete.1 +++ b/docs/man/man1/oc-delete.1 @@ -19,13 +19,10 @@ Delete a resource JSON and YAML formats are accepted. .PP -If both a filename and command line arguments are passed, the command line -arguments are used and the filename is ignored. +If both a filename and command line arguments are passed, the command linearguments are used and the filename is ignored. .PP -Note that the delete command does NOT do resource version checks, so if someone -submits an update to a resource right when you submit a delete, their update -will be lost along with the rest of the resource. +Note that the delete command does NOT do resource version checks, so if someonesubmits an update to a resource right when you submit a delete, their updatewill be lost along with the rest of the resource. .SH OPTIONS @@ -147,21 +144,21 @@ will be lost along with the rest of the resource. .nf # Delete a pod using the type and ID specified in pod.json. oc delete \-f pod.json - + # Delete a pod based on the type and ID in the JSON passed into stdin. cat pod.json | oc delete \-f \- - + # Delete pods and services with label name=myLabel. oc delete pods,services \-l name=myLabel - + # Delete a pod with name node\-1\-vsjnm. oc delete pod node\-1\-vsjnm - + # Delete all resources associated with a running app, includes # buildconfig,deploymentconfig,service,imagestream,route and pod, # where 'appName' is listed in 'Labels' of 'oc describe [resource] [resource name]' output. oc delete all \-l app=appName - + # Delete all pods oc delete pods \-\-all diff --git a/docs/man/man1/oc-deploy.1 b/docs/man/man1/oc-deploy.1 index 591c79de970d..29d2e6af12ce 100644 --- a/docs/man/man1/oc-deploy.1 +++ b/docs/man/man1/oc-deploy.1 @@ -16,36 +16,23 @@ oc deploy \- View, start, cancel, or retry a deployment View, start, cancel, or retry a deployment .PP -This command allows you to control a deployment config. Each individual deployment is exposed -as a new replication controller, and the deployment process manages scaling down old deployments -and scaling up new ones. Use 'oc rollback' to rollback to any previous deployment. +This command allows you to control a deployment config. Each individual deployment is exposedas a new replication controller, and the deployment process manages scaling down old deploymentsand scaling up new ones. Use 'oc rollback' to rollback to any previous deployment. .PP There are several deployment strategies defined: .IP .IP -\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number -of old deployments. If one of the new deployed pods never becomes "ready", the new deployment -will be rolled back (scaled down to zero). Use when your application can tolerate two versions -of code running at the same time (many web applications, scalable databases) +\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the numberof old deployments. If one of the new deployed pods never becomes "ready", the new deploymentwill be rolled back (scaled down to zero). Use when your application can tolerate two versionsof code running at the same time (many web applications, scalable databases) .IP -\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full. -Use when your application cannot tolerate two versions of code running at the same time +\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.Use when your application cannot tolerate two versions of code running at the same time .IP \(bu Custom \- run your own deployment process inside a Docker container using your own scripts. .PP -If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may -never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment. -If a deployment config has completed deploying successfully at least once in the past, it would be -automatically rolled back in the event of a new failed deployment. Note that you would still need -to update the erroneous deployment config in order to have its template persisted across your -application. +If a deployment fails, you may opt to retry it (if the error was transient). Some deployments maynever successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment.If a deployment config has completed deploying successfully at least once in the past, it would beautomatically rolled back in the event of a new failed deployment. Note that you would still needto update the erroneous deployment config in order to have its template persisted across yourapplication. .PP -If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effort -operation and may take some time to complete. It’s possible the deployment will partially or totally -complete before the cancellation is effective. In such a case an appropriate event will be emitted. +If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effortoperation and may take some time to complete. It’s possible the deployment will partially or totallycomplete before the cancellation is effective. In such a case an appropriate event will be emitted. .PP If no options are given, shows information about the latest deployment. @@ -146,17 +133,17 @@ If no options are given, shows information about the latest deployment. .nf # Display the latest deployment for the 'database' deployment config oc deploy database - + # Start a new deployment based on the 'database' oc deploy database \-\-latest - + # Start a new deployment and follow its log oc deploy database \-\-latest \-\-follow - + # Retry the latest failed deployment based on 'frontend' # The deployer pod and any hook pods are deleted for the latest failed deployment oc deploy frontend \-\-retry - + # Cancel the in\-progress deployment based on 'frontend' oc deploy frontend \-\-cancel diff --git a/docs/man/man1/oc-describe.1 b/docs/man/man1/oc-describe.1 index d7d4c95fd872..26add52528b6 100644 --- a/docs/man/man1/oc-describe.1 +++ b/docs/man/man1/oc-describe.1 @@ -16,8 +16,7 @@ oc describe \- Show details of a specific resource or group of resources Show details of a specific resource .PP -This command joins many API calls together to form a detailed description of a -given resource. +This command joins many API calls together to form a detailed description of agiven resource. .SH OPTIONS @@ -119,7 +118,7 @@ given resource. .nf # Provide details about the ruby\-22\-centos7 image repository oc describe imageRepository ruby\-22\-centos7 - + # Provide details about the ruby\-sample\-build build configuration oc describe bc ruby\-sample\-build diff --git a/docs/man/man1/oc-edit.1 b/docs/man/man1/oc-edit.1 index 9080f808587d..0bfb2533ee22 100644 --- a/docs/man/man1/oc-edit.1 +++ b/docs/man/man1/oc-edit.1 @@ -16,25 +16,13 @@ oc edit \- Edit a resource on the server Edit a resource from the default editor .PP -The edit command allows you to directly edit any API resource you can retrieve via the -command line tools. It will open the editor defined by your OC\_EDITOR, or EDITOR environment -variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple -objects, although changes are applied one at a time. The command accepts filenames as well -as command line arguments, although the files you point to must be previously saved versions -of resources. +The edit command allows you to directly edit any API resource you can retrieve via thecommand line tools. It will open the editor defined by your OC\_EDITOR, or EDITOR environmentvariables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multipleobjects, although changes are applied one at a time. The command accepts filenames as wellas command line arguments, although the files you point to must be previously saved versionsof resources. .PP -The files to edit will be output in the default API version, or a version specified -by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON -pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, -otherwise the default for your operating system will be used. +The files to edit will be output in the default API version, or a version specifiedby \-\-output\-version. The default format is YAML \- if you would like to edit in JSONpass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings,otherwise the default for your operating system will be used. .PP -In the event an error occurs while updating, a temporary file will be created on disk -that contains your unapplied changes. The most common error when updating a resource -is another editor changing the resource on the server. When this occurs, you will have -to apply your changes to the newer version of the resource, or update your temporary -saved copy to include the latest resource version. +In the event an error occurs while updating, a temporary file will be created on diskthat contains your unapplied changes. The most common error when updating a resourceis another editor changing the resource on the server. When this occurs, you will haveto apply your changes to the newer version of the resource, or update your temporarysaved copy to include the latest resource version. .SH OPTIONS @@ -152,13 +140,13 @@ saved copy to include the latest resource version. .nf # Edit the service named 'docker\-registry': oc edit svc/docker\-registry - + # Edit the DeploymentConfig named 'my\-deployment': oc edit dc/my\-deployment - + # Use an alternative editor OC\_EDITOR="nano" oc edit dc/my\-deployment - + # Edit the service 'docker\-registry' in JSON using the v1 API format: oc edit svc/docker\-registry \-\-output\-version=v1 \-o json diff --git a/docs/man/man1/oc-env.1 b/docs/man/man1/oc-env.1 index 108488ffafdd..d1f579647bc6 100644 --- a/docs/man/man1/oc-env.1 +++ b/docs/man/man1/oc-env.1 @@ -143,32 +143,32 @@ DEPRECATED: This command has been moved to "oc set env" .nf # Update deployment 'registry' with a new environment variable oc env dc/registry STORAGE\_DIR=/local - + # List the environment variables defined on a build config 'sample\-build' oc env bc/sample\-build \-\-list - + # List the environment variables defined on all pods oc env pods \-\-all \-\-list - + # Output modified build config in YAML, and does not alter the object on the server oc env bc/sample\-build STORAGE\_DIR=/data \-o yaml - + # Update all containers in all replication controllers in the project to have ENV=prod oc env rc \-\-all ENV=prod - + # Import environment from a secret oc env \-\-from=secret/mysecret dc/myapp - + # Import environment from a config map with a prefix oc env \-\-from=configmap/myconfigmap \-\-prefix=MYSQL\_ dc/myapp - + # Remove the environment variable ENV from container 'c1' in all deployment configs oc env dc \-\-all \-\-containers="c1" ENV\- - + # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server oc env \-f dc.json ENV\- - + # Set some of the local shell environment into a deployment config on the server env | grep RAILS\_ | oc env \-e \- dc/registry diff --git a/docs/man/man1/oc-ex-dockerbuild.1 b/docs/man/man1/oc-ex-dockerbuild.1 index d267c2d7a80d..1c2f50b3a91c 100644 --- a/docs/man/man1/oc-ex-dockerbuild.1 +++ b/docs/man/man1/oc-ex-dockerbuild.1 @@ -16,10 +16,7 @@ oc ex dockerbuild \- Perform a direct Docker build Build a Dockerfile into a single layer .PP -Builds the provided directory with a Dockerfile into a single layered image. -Requires that you have a working connection to a Docker engine. You may mount -secrets or config into the build with the \-\-mount flag \- these files will not -be included in the final image. +Builds the provided directory with a Dockerfile into a single layered image.Requires that you have a working connection to a Docker engine. You may mountsecrets or config into the build with the \-\-mount flag \- these files will notbe included in the final image. .PP Experimental: This command is under active development and may change without notice. @@ -112,7 +109,7 @@ Experimental: This command is under active development and may change without no .nf # Build the current directory into a single layer and tag oc ex dockerbuild . myimage:latest - + # Mount a client secret into the build at a certain path oc ex dockerbuild . myimage:latest \-\-mount \~/mysecret.pem:/etc/pki/secret/mysecret.pem diff --git a/docs/man/man1/oc-exec.1 b/docs/man/man1/oc-exec.1 index 264e82c482ba..f6412f00ffc4 100644 --- a/docs/man/man1/oc-exec.1 +++ b/docs/man/man1/oc-exec.1 @@ -107,7 +107,7 @@ Execute a command in a container .nf # Get output from running 'date' in ruby\-container from pod 'mypod' oc exec mypod \-c ruby\-container date - + # Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 'mypod' and sends stdout/stderr from 'bash' back to the client oc exec mypod \-c ruby\-container \-i \-t \-\- bash \-il diff --git a/docs/man/man1/oc-explain.1 b/docs/man/man1/oc-explain.1 index a3f93cbcedeb..0826c33f7c94 100644 --- a/docs/man/man1/oc-explain.1 +++ b/docs/man/man1/oc-explain.1 @@ -16,10 +16,7 @@ oc explain \- Documentation of resources Documentation of resources. .PP -Possible resource types include: pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -resourcequotas (quota), namespaces (ns) or endpoints (ep). +Possible resource types include: pods (po), services (svc),replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),resourcequotas (quota), namespaces (ns) or endpoints (ep). .SH OPTIONS @@ -103,11 +100,11 @@ resourcequotas (quota), namespaces (ns) or endpoints (ep). .RS .nf -# Get the documentation of the resource and its fields -oc explain pods - -# Get the documentation of a specific field of a resource -oc explain pods.spec.containers + # Get the documentation of the resource and its fields + oc explain pods + + # Get the documentation of a specific field of a resource + oc explain pods.spec.containers .fi .RE diff --git a/docs/man/man1/oc-export.1 b/docs/man/man1/oc-export.1 index 0e8f7b41909f..b141bd31e4f5 100644 --- a/docs/man/man1/oc-export.1 +++ b/docs/man/man1/oc-export.1 @@ -16,21 +16,13 @@ oc export \- Export resources so they can be used elsewhere Export resources so they can be used elsewhere .PP -The export command makes it easy to take existing objects and convert them to configuration files -for backups or for creating elsewhere in the cluster. Fields that cannot be specified on create -will be set to empty, and any field which is assigned on creation (like a service's clusterIP, or -a deployment config's latestVersion). The status part of objects is also cleared. +The export command makes it easy to take existing objects and convert them to configuration filesfor backups or for creating elsewhere in the cluster. Fields that cannot be specified on createwill be set to empty, and any field which is assigned on creation (like a service's clusterIP, ora deployment config's latestVersion). The status part of objects is also cleared. .PP -Some fields like clusterIP may be useful when exporting an application from one cluster to apply -to another \- assuming another service on the destination cluster does not already use that IP. -The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use -\-\-raw to get the exact values for an object \- useful for converting a file on disk between API -versions. +Some fields like clusterIP may be useful when exporting an application from one cluster to applyto another \- assuming another service on the destination cluster does not already use that IP.The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use\-\-raw to get the exact values for an object \- useful for converting a file on disk between APIversions. .PP -Another use case for export is to create reusable templates for applications. Pass \-\-as\-template -to generate the API structure for a template to which you can add parameters and object labels. +Another use case for export is to create reusable templates for applications. Pass \-\-as\-templateto generate the API structure for a template to which you can add parameters and object labels. .SH OPTIONS @@ -168,10 +160,10 @@ to generate the API structure for a template to which you can add parameters and .nf # export the services and deployment configurations labeled name=test oc export svc,dc \-l name=test - + # export all services to a template oc export service \-\-as\-template=test - + # export to JSON oc export service \-o json diff --git a/docs/man/man1/oc-expose.1 b/docs/man/man1/oc-expose.1 index fddb7ba21fec..782dbaa58335 100644 --- a/docs/man/man1/oc-expose.1 +++ b/docs/man/man1/oc-expose.1 @@ -16,9 +16,7 @@ oc expose \- Expose a replicated application as a service or route Expose containers internally as services or externally via routes .PP -There is also the ability to expose a deployment configuration, replication controller, service, or pod -as a new service on a specified port. If no labels are specified, the new object will re\-use the -labels from the object it exposes. +There is also the ability to expose a deployment configuration, replication controller, service, or podas a new service on a specified port. If no labels are specified, the new object will re\-use thelabels from the object it exposes. .SH OPTIONS @@ -216,16 +214,16 @@ labels from the object it exposes. .nf # Create a route based on service nginx. The new route will re\-use nginx's labels oc expose service nginx - + # Create a route and specify your own label and route name oc expose service nginx \-l name=myroute \-\-name=fromdowntown - + # Create a route and specify a hostname oc expose service nginx \-\-hostname=www.example.com - + # Expose a deployment configuration as a service and use the specified port oc expose dc ruby\-hello\-world \-\-port=8080 - + # Expose a service as a route in the specified path oc expose service nginx \-\-path=/nginx diff --git a/docs/man/man1/oc-extract.1 b/docs/man/man1/oc-extract.1 index 4e85485b2e1e..a79f0c18b2fe 100644 --- a/docs/man/man1/oc-extract.1 +++ b/docs/man/man1/oc-extract.1 @@ -16,13 +16,10 @@ oc extract \- Extract secrets or config maps to disk Extract files out of secrets and config maps .PP -The extract command makes it easy to download the contents of a config map or secret into a directory. -Each key in the config map or secret is created as a separate file with the name of the key, as it -is when you mount a secret or config map into a container. +The extract command makes it easy to download the contents of a config map or secret into a directory.Each key in the config map or secret is created as a separate file with the name of the key, as itis when you mount a secret or config map into a container. .PP -You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract to -with \-\-to=DIRECTORY. +You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract towith \-\-to=DIRECTORY. .SH OPTIONS @@ -148,10 +145,10 @@ with \-\-to=DIRECTORY. .nf # extract the secret "test" to the current directory oc extract secret/test - + # extract the config map "nginx" to the /tmp directory oc extract configmap/nginx \-\-to=/tmp - + # extract only the key "nginx.conf" from config map "nginx" to the /tmp directory oc extract configmap/nginx \-\-to=/tmp \-\-keys=nginx.conf diff --git a/docs/man/man1/oc-get.1 b/docs/man/man1/oc-get.1 index eab82c52bd2b..cf6f7f73b3f8 100644 --- a/docs/man/man1/oc-get.1 +++ b/docs/man/man1/oc-get.1 @@ -16,10 +16,7 @@ oc get \- Display one or many resources Display one or many resources .PP -Possible resources include builds, buildConfigs, services, pods, etc. To see a -list of common resources, use 'oc get'. Some resources may omit -advanced details that you can see with '\-o wide'. If you want an even more -detailed view, use 'oc describe'. +Possible resources include builds, buildConfigs, services, pods, etc. To seea list of common resources, use 'oc get'. Some resources may omit advanceddetails that you can see with '\-o wide'. If you want an even more detailedview, use 'oc describe'. .SH OPTIONS @@ -173,16 +170,16 @@ detailed view, use 'oc describe'. .nf # List all pods in ps output format. oc get pods - + # List a single replication controller with specified ID in ps output format. oc get rc redis - + # List all pods and show more details about them. oc get \-o wide pods - + # List a single pod in JSON output format. oc get \-o json pod redis\-pod - + # Return only the status value of the specified pod. oc get \-o template pod redis\-pod \-\-template={{.currentState.status}} diff --git a/docs/man/man1/oc-idle.1 b/docs/man/man1/oc-idle.1 index d55cc2b597d6..745bcf55116f 100644 --- a/docs/man/man1/oc-idle.1 +++ b/docs/man/man1/oc-idle.1 @@ -13,17 +13,13 @@ oc idle \- Idle scalable resources .SH DESCRIPTION .PP -Idle scalable resources. +Idle scalable resources .PP -Idling discovers the scalable resources (such as deployment configs and replication controllers) -associated with a series of services by examining the endpoints of the service. -Each service is then marked as idled, the associated resources are recorded, and the resources -are scaled down to zero replicas. +Idling discovers the scalable resources (such as deployment configs and replication controllers)associated with a series of services by examining the endpoints of the service.Each service is then marked as idled, the associated resources are recorded, and the resourcesare scaled down to zero replicas. .PP -Upon receiving network traffic, the services (and any associated routes) will "wake up" the -associated resources by scaling them back up to their previous scale. +Upon receiving network traffic, the services (and any associated routes) will "wake up" theassociated resources by scaling them back up to their previous scale. .SH OPTIONS diff --git a/docs/man/man1/oc-import-app.json.1 b/docs/man/man1/oc-import-app.json.1 index 51a7ba951439..a6ae17729c80 100644 --- a/docs/man/man1/oc-import-app.json.1 +++ b/docs/man/man1/oc-import-app.json.1 @@ -16,14 +16,10 @@ oc import app.json \- Import an app.json definition into OpenShift (experimental Import app.json files as OpenShift objects .PP -app.json defines the pattern of a simple, stateless web application that can be horizontally scaled. -This command will transform a provided app.json object into its OpenShift equivalent. -During transformation fields in the app.json syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +app.json defines the pattern of a simple, stateless web application that can be horizontally scaled.This command will transform a provided app.json object into its OpenShift equivalent.During transformation fields in the app.json syntax that are not relevant when running on top ofa containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate aconfiguration file for later use. .PP Experimental: This command is under active development and may change without notice. @@ -132,11 +128,10 @@ Experimental: This command is under active development and may change without no .nf # Import a directory containing an app.json file $ oc import app.json \-f . - + # Turn an app.json file into a template $ oc import app.json \-f ./app.json \-o yaml \-\-as\-template - .fi .RE diff --git a/docs/man/man1/oc-import-docker-compose.1 b/docs/man/man1/oc-import-docker-compose.1 index 912f095b0522..4c4404e1c98c 100644 --- a/docs/man/man1/oc-import-docker-compose.1 +++ b/docs/man/man1/oc-import-docker-compose.1 @@ -16,14 +16,10 @@ oc import docker\-compose \- Import a docker\-compose.yml project into OpenShift Import a Docker Compose file as OpenShift objects .PP -Docker Compose files offer a container centric build and deploy pattern for simple applications. -This command will transform a provided docker\-compose.yml application into its OpenShift equivalent. -During transformation fields in the compose syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +Docker Compose files offer a container centric build and deploy pattern for simple applications.This command will transform a provided docker\-compose.yml application into its OpenShift equivalent.During transformation fields in the compose syntax that are not relevant when running on top ofa containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate aconfiguration file for later use. .PP Experimental: This command is under active development and may change without notice. @@ -128,11 +124,10 @@ Experimental: This command is under active development and may change without no .nf # Import a docker\-compose.yml file into OpenShift oc import docker\-compose \-f ./docker\-compose.yml - - # Turn a docker\-compose.yml file into a template + + # Turn a docker\-compose.yml file into a template oc import docker\-compose \-f ./docker\-compose.yml \-o yaml \-\-as\-template - .fi .RE diff --git a/docs/man/man1/oc-import-image.1 b/docs/man/man1/oc-import-image.1 index 7259b240fc31..89189bc5162d 100644 --- a/docs/man/man1/oc-import-image.1 +++ b/docs/man/man1/oc-import-image.1 @@ -16,8 +16,7 @@ oc import\-image \- Imports images from a Docker registry Import tag and image information from an external Docker image repository .PP -Only image streams that have a value set for spec.dockerImageRepository and/or -spec.Tags may have tag and image information imported. +Only image streams that have a value set for spec.dockerImageRepository and/orspec.Tags may have tag and image information imported. .SH OPTIONS diff --git a/docs/man/man1/oc-label.1 b/docs/man/man1/oc-label.1 index 4fb0bc827a11..de8d2fe390c6 100644 --- a/docs/man/man1/oc-label.1 +++ b/docs/man/man1/oc-label.1 @@ -16,11 +16,7 @@ oc label \- Update the labels on a resource Update the labels on one or more resources .PP -A valid label value is consisted of letters and/or numbers with a max length of 63 -characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwise -attempting to overwrite a label will result in an error. If \-\-resource\-version is -specified, then updates will use this resource version, otherwise the existing -resource\-version will be used. +A valid label value is consisted of letters and/or numbers with a max length of 63characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwiseattempting to overwrite a label will result in an error. If \-\-resource\-version isspecified, then updates will use this resource version, otherwise the existingresource\-version will be used. .SH OPTIONS @@ -166,16 +162,16 @@ resource\-version will be used. .nf # Update pod 'foo' with the label 'unhealthy' and the value 'true'. oc label pods foo unhealthy=true - + # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. oc label \-\-overwrite pods foo status=unhealthy - + # Update all pods in the namespace oc label pods \-\-all status=unhealthy - + # Update pod 'foo' only if the resource is unchanged from version 1. oc label pods foo status=unhealthy \-\-resource\-version=1 - + # Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the \-\-overwrite flag. oc label pods foo bar\- diff --git a/docs/man/man1/oc-login.1 b/docs/man/man1/oc-login.1 index 1dd4a30265a9..d184a9bbaed1 100644 --- a/docs/man/man1/oc-login.1 +++ b/docs/man/man1/oc-login.1 @@ -16,15 +16,10 @@ oc login \- Log in to a server Log in to your server and save login for subsequent use .PP -First\-time users of the client should run this command to connect to a server, -establish an authenticated session, and save connection to the configuration file. The -default configuration will be saved to your home directory under -".kube/config". +First\-time users of the client should run this command to connect to a server,establish an authenticated session, and save connection to the configuration file. Thedefault configuration will be saved to your home directory under".kube/config". .PP -The information required to login \-\- like username and password, a session token, or -the server details \-\- can be provided through flags. If not provided, the command will -prompt for user input as needed. +The information required to login \-\- like username and password, a session token, orthe server details \-\- can be provided through flags. If not provided, the command willprompt for user input as needed. .SH OPTIONS @@ -110,10 +105,10 @@ prompt for user input as needed. .nf # Log in interactively oc login - + # Log in to the given server with the given certificate authority file oc login localhost:8443 \-\-certificate\-authority=/path/to/cert.crt - + # Log in to the given server with the given credentials (will not prompt interactively) oc login localhost:8443 \-\-username=myuser \-\-password=mypass diff --git a/docs/man/man1/oc-logout.1 b/docs/man/man1/oc-logout.1 index 1c4cfac660fd..840c8822154b 100644 --- a/docs/man/man1/oc-logout.1 +++ b/docs/man/man1/oc-logout.1 @@ -16,14 +16,10 @@ oc logout \- End the current server session Log out of the active session out by clearing saved tokens .PP -An authentication token is stored in the config file after login \- this command will delete -that token on the server, and then remove the token from the configuration file. +An authentication token is stored in the config file after login \- this command will deletethat token on the server, and then remove the token from the configuration file. .PP -If you are using an alternative authentication method like Kerberos or client certificates, -your ticket or client certificate will not be removed from the current system since these -are typically managed by other programs. Instead, you can delete your config file to remove -the local copy of that certificate or the record of your server login. +If you are using an alternative authentication method like Kerberos or client certificates,your ticket or client certificate will not be removed from the current system since theseare typically managed by other programs. Instead, you can delete your config file to removethe local copy of that certificate or the record of your server login. .PP After logging out, if you want to log back into the server use 'oc login'. @@ -100,7 +96,6 @@ After logging out, if you want to log back into the server use 'oc login'. .RS .nf - # Logout oc logout diff --git a/docs/man/man1/oc-logs.1 b/docs/man/man1/oc-logs.1 index 3402e1056f1b..b9e481467247 100644 --- a/docs/man/man1/oc-logs.1 +++ b/docs/man/man1/oc-logs.1 @@ -13,17 +13,13 @@ oc logs \- Print the logs for a resource. .SH DESCRIPTION .PP -Print the logs for a resource. +Print the logs for a resource .PP -Supported resources are builds, build configs (bc), deployment configs (dc), and pods. -When a pod is specified and has more than one container, the container name should be -specified via \-c. When a build config or deployment config is specified, you can view -the logs for a particular version of it via \-\-version. +Supported resources are builds, build configs (bc), deployment configs (dc), and pods.When a pod is specified and has more than one container, the container name should bespecified via \-c. When a build config or deployment config is specified, you can viewthe logs for a particular version of it via \-\-version. .PP -If your pod is failing to start, you may need to use the \-\-previous option to see the -logs of the last attempt. +If your pod is failing to start, you may need to use the \-\-previous option to see thelogs of the last attempt. .SH OPTIONS @@ -145,18 +141,18 @@ logs of the last attempt. .nf # Start streaming the logs of the most recent build of the openldap build config. oc logs \-f bc/openldap - + # Start streaming the logs of the latest deployment of the mysql deployment config. oc logs \-f dc/mysql - + # Get the logs of the first deployment for the mysql deployment config. Note that logs # from older deployments may not exist either because the deployment was successful # or due to deployment pruning or manual deletion of the deployment. oc logs \-\-version=1 dc/mysql - + # Return a snapshot of ruby\-container logs from pod backend. oc logs backend \-c ruby\-container - + # Start streaming of ruby\-container logs from pod backend. oc logs \-f pod/backend \-c ruby\-container diff --git a/docs/man/man1/oc-new-app.1 b/docs/man/man1/oc-new-app.1 index f74a0bf3229f..1ab845510667 100644 --- a/docs/man/man1/oc-new-app.1 +++ b/docs/man/man1/oc-new-app.1 @@ -16,21 +16,13 @@ oc new\-app \- Create a new application Create a new application by specifying source code, templates, and/or images .PP -This command will try to build up the components of an application using images, templates, -or code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, an integrated image stream, or stored templates. +This command will try to build up the components of an application using images, templates,or code that has a public repository. It will lookup the images on the local Docker installation(if available), a Docker registry, an integrated image stream, or stored templates. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. The images will be deployed via a deployment -configuration, and a service will be connected to the first public port of the app. You may either specify -components using the various existing flags or let new\-app autodetect what kind of components -you have provided. +If you specify a source code URL, it will set up a build that takes your source code and convertsit into an image that can run inside of a pod. Local source must be in a git repository that has aremote repository that the server can see. The images will be deployed via a deploymentconfiguration, and a service will be connected to the first public port of the app. You may either specifycomponents using the various existing flags or let new\-app autodetect what kind of componentsyou have provided. .PP -If you provide source code, a new build will be automatically triggered. -You can use 'oc status' to check the progress. +If you provide source code, a new build will be automatically triggered.You can use 'oc status' to check the progress. .SH OPTIONS @@ -202,42 +194,41 @@ You can use 'oc status' to check the progress. .RS .nf - # List all local templates and image streams that can be used to create an app oc new\-app \-\-list - + # Create an application based on the source code in the current git repository (with a public remote) # and a Docker image oc new\-app . \-\-docker\-image=repo/langimage - + # Create a Ruby application based on the provided [image]\~[source code] combination oc new\-app centos/ruby\-22\-centos7\~https://github.com/openshift/ruby\-ex.git - + # Use the public Docker Hub MySQL image to create an app. Generated artifacts will be labeled with db=mysql oc new\-app mysql MYSQL\_USER=user MYSQL\_PASSWORD=pass MYSQL\_DATABASE=testdb \-l db=mysql - + # Use a MySQL image in a private registry to create an app and override application artifacts' names oc new\-app \-\-docker\-image=myregistry.com/mycompany/mysql \-\-name=private - + # Create an application from a remote repository using its beta4 branch oc new\-app https://github.com/openshift/ruby\-hello\-world#beta4 - + # Create an application based on a stored template, explicitly setting a parameter value oc new\-app \-\-template=ruby\-helloworld\-sample \-\-param=MYSQL\_USER=admin - + # Create an application from a remote repository and specify a context directory oc new\-app https://github.com/youruser/yourgitrepo \-\-context\-dir=src/build - + # Create an application based on a template file, explicitly setting a parameter value oc new\-app \-\-file=./example/myapp/template.json \-\-param=MYSQL\_USER=admin - + # Search all templates, image streams, and Docker images for the ones that match "ruby" oc new\-app \-\-search ruby - + # Search for "ruby", but only in stored templates (\-\-template, \-\-image\-stream and \-\-docker\-image # can be used to filter search results) oc new\-app \-\-search \-\-template=ruby - + # Search for "ruby" in stored templates and print the output as an YAML oc new\-app \-\-search \-\-template=ruby \-\-output=yaml diff --git a/docs/man/man1/oc-new-build.1 b/docs/man/man1/oc-new-build.1 index 9cab29ffc793..b3c52d167e01 100644 --- a/docs/man/man1/oc-new-build.1 +++ b/docs/man/man1/oc-new-build.1 @@ -16,18 +16,13 @@ oc new\-build \- Create a new build configuration Create a new build by specifying source code .PP -This command will try to create a build configuration for your application using images and -code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, or an image stream. +This command will try to create a build configuration for your application using images andcode that has a public repository. It will lookup the images on the local Docker installation(if available), a Docker registry, or an image stream. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. +If you specify a source code URL, it will set up a build that takes your source code and convertsit into an image that can run inside of a pod. Local source must be in a git repository that has aremote repository that the server can see. .PP -Once the build configuration is created a new build will be automatically triggered. -You can use 'oc status' to check the progress. +Once the build configuration is created a new build will be automatically triggered.You can use 'oc status' to check the progress. .SH OPTIONS @@ -191,26 +186,25 @@ You can use 'oc status' to check the progress. .RS .nf - # Create a build config based on the source code in the current git repository (with a public # remote) and a Docker image oc new\-build . \-\-docker\-image=repo/langimage - + # Create a NodeJS build config based on the provided [image]\~[source code] combination oc new\-build openshift/nodejs\-010\-centos7\~https://github.com/openshift/nodejs\-ex.git - + # Create a build config from a remote repository using its beta2 branch oc new\-build https://github.com/openshift/ruby\-hello\-world#beta2 - + # Create a build config using a Dockerfile specified as an argument oc new\-build \-D $'FROM centos:7\\nRUN yum install \-y httpd' - + # Create a build config from a remote repository and add custom environment variables oc new\-build https://github.com/openshift/ruby\-hello\-world RACK\_ENV=development - + # Create a build config from a remote repository and inject the npmrc into a build oc new\-build https://github.com/openshift/ruby\-hello\-world \-\-build\-secret npmrc:.npmrc - + # Create a build config that gets its input from a remote repository and another Docker image oc new\-build https://github.com/openshift/ruby\-hello\-world \-\-source\-image=openshift/jenkins\-1\-centos7 \-\-source\-image\-path=/var/lib/jenkins:tmp diff --git a/docs/man/man1/oc-new-project.1 b/docs/man/man1/oc-new-project.1 index a8d9795dd7b2..7acead2893ab 100644 --- a/docs/man/man1/oc-new-project.1 +++ b/docs/man/man1/oc-new-project.1 @@ -16,8 +16,7 @@ oc new\-project \- Request a new project Create a new project for yourself .PP -If your administrator allows self\-service, this command will create a new project for you and assign you -as the project admin. +If your administrator allows self\-service, this command will create a new project for you and assign youas the project admin. .PP After your project is created it will become the default project in your config. @@ -110,7 +109,7 @@ After your project is created it will become the default project in your config. .nf # Create a new project with minimal information oc new\-project web\-team\-dev - + # Create a new project with a display name and description oc new\-project web\-team\-dev \-\-display\-name="Web Team Development" \-\-description="Development project for the web team." diff --git a/docs/man/man1/oc-observe.1 b/docs/man/man1/oc-observe.1 index 00d808f9d835..711447fea0d6 100644 --- a/docs/man/man1/oc-observe.1 +++ b/docs/man/man1/oc-observe.1 @@ -16,16 +16,10 @@ oc observe \- Observe changes to resources and react to them (experimental) Observe changes to resources and take action on them .PP -This command assists in building scripted reactions to changes that occur in -Kubernetes or OpenShift resources. This is frequently referred to as a -'controller' in Kubernetes and acts to ensure particular conditions are -maintained. On startup, observe will list all of the resources of a -particular type and execute the provided script on each one. Observe watches -the server for changes, and will reexecute the script for each update. +This command assists in building scripted reactions to changes that occur inKubernetes or OpenShift resources. This is frequently referred to as a'controller' in Kubernetes and acts to ensure particular conditions aremaintained. On startup, observe will list all of the resources of aparticular type and execute the provided script on each one. Observe watchesthe server for changes, and will reexecute the script for each update. .PP -Observe works best for problems of the form "for every resource X, make sure -Y is true". Some examples of ways observe can be used include: +Observe works best for problems of the form "for every resource X, make sureY is true". Some examples of ways observe can be used include: .IP .IP @@ -41,11 +35,7 @@ Y is true". Some examples of ways observe can be used include: .IP \(bu Delete pods that have reached successful completion after a period of time. .PP -The simplest pattern is maintaining an invariant on an object \- for instance, -"every namespace should have an annotation that indicates its owner". If the -object is deleted no reaction is necessary. A variation on that pattern is -creating another object: "every namespace should have a quota object based -on the resources allowed for an owner". +The simplest pattern is maintaining an invariant on an object \- for instance,"every namespace should have an annotation that indicates its owner". If theobject is deleted no reaction is necessary. A variation on that pattern iscreating another object: "every namespace should have a quota object basedon the resources allowed for an owner". .PP $ cat set\_owner.sh @@ -58,23 +48,13 @@ $ cat set\_owner.sh $ oc observe namespaces \-\- ./set\_owner.sh .PP -The set\_owner.sh script is invoked with a single argument (the namespace name) -for each namespace. This simple script ensures that any user without the -"owner" annotation gets one set, but preserves any existing value. +The set\_owner.sh script is invoked with a single argument (the namespace name)for each namespace. This simple script ensures that any user without the"owner" annotation gets one set, but preserves any existing value. .PP -The next common of controller pattern is provisioning \- making changes in an -external system to match the state of a Kubernetes resource. These scripts need -to account for deletions that may take place while the observe command is not -running. You can provide the list of known objects via the \-\-names command, -which should return a newline\-delimited list of names or namespace/name pairs. -Your command will be invoked whenever observe checks the latest state on the -server \- any resources returned by \-\-names that are not found on the server -will be passed to your \-\-delete command. +The next common of controller pattern is provisioning \- making changes in anexternal system to match the state of a Kubernetes resource. These scripts needto account for deletions that may take place while the observe command is notrunning. You can provide the list of known objects via the \-\-names command,which should return a newline\-delimited list of names or namespace/name pairs.Your command will be invoked whenever observe checks the latest state on theserver \- any resources returned by \-\-names that are not found on the serverwill be passed to your \-\-delete command. .PP -For example, you may wish to ensure that every node that is added to Kubernetes -is added to your cluster inventory along with its IP: +For example, you may wish to ensure that every node that is added to Kubernetesis added to your cluster inventory along with its IP: .PP $ cat add\_to\_inventory.sh @@ -96,27 +76,18 @@ $ cat known\_nodes.sh .PP $ oc observe nodes \-a '{ .status.addresses[0].address }' \\ - \-\-names ./known\_nodes.sh \\ - \-\-delete ./remove\_from\_inventory.sh \\ - \-\- ./add\_to\_inventory.sh + \-\-names ./known\_nodes.sh \\ + \-\-delete ./remove\_from\_inventory.sh \\ + \-\- ./add\_to\_inventory.sh .PP -If you stop the observe command and then delete a node, when you launch observe -again the contents of inventory will be compared to the list of nodes from the -server, and any node in the inventory file that no longer exists will trigger -a call to remove\_from\_inventory.sh with the name of the node. +If you stop the observe command and then delete a node, when you launch observeagain the contents of inventory will be compared to the list of nodes from theserver, and any node in the inventory file that no longer exists will triggera call to removefrominventory.sh with the name of the node. .PP -Important: when handling deletes, the previous state of the object may not be - available and only the name/namespace of the object will be passed to your - \-\-delete command as arguments (all custom arguments are omitted). +Important: when handling deletes, the previous state of the object may not beavailable and only the name/namespace of the object will be passed to your\-\-delete command as arguments (all custom arguments are omitted). .PP -More complicated interactions build on the two examples above \- your inventory -script could make a call to allocate storage on your infrastructure as a -service, or register node names in DNS, or set complex firewalls. The more -complex your integration, the more important it is to record enough data in the -remote system that you can identify when resources on either side are deleted. +More complicated interactions build on the two examples above \- your inventoryscript could make a call to allocate storage on your infrastructure as aservice, or register node names in DNS, or set complex firewalls. The morecomplex your integration, the more important it is to record enough data in theremote system that you can identify when resources on either side are deleted. .PP Experimental: This command is under active development and may change without notice. @@ -263,12 +234,11 @@ Experimental: This command is under active development and may change without no .RS .nf - # observe changes to services - oc observe services - - # observe changes to services, including the clusterIP and invoke a script for each - oc observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh - + # Observe changes to services + oc observe services + + # Observe changes to services, including the clusterIP and invoke a script for each + oc observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh .fi .RE diff --git a/docs/man/man1/oc-policy-add-role-to-user.1 b/docs/man/man1/oc-policy-add-role-to-user.1 index 9bb7c09e0e79..3f489afe23ad 100644 --- a/docs/man/man1/oc-policy-add-role-to-user.1 +++ b/docs/man/man1/oc-policy-add-role-to-user.1 @@ -99,7 +99,7 @@ Add a role to users or serviceaccounts for the current project .nf # Add the 'view' role to user1 for the current project oc policy add\-role\-to\-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project oc policy add\-role\-to\-user edit \-z serviceaccount1 diff --git a/docs/man/man1/oc-port-forward.1 b/docs/man/man1/oc-port-forward.1 index 43ed0fe08cab..5fa812363c94 100644 --- a/docs/man/man1/oc-port-forward.1 +++ b/docs/man/man1/oc-port-forward.1 @@ -95,13 +95,13 @@ Forward 1 or more local ports to a pod .nf # Listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod oc port\-forward mypod 5000 6000 - + # Listens on port 8888 locally, forwarding to 5000 in the pod oc port\-forward mypod 8888:5000 - + # Listens on a random port locally, forwarding to 5000 in the pod oc port\-forward mypod :5000 - + # Listens on a random port locally, forwarding to 5000 in the pod oc port\-forward mypod 0:5000 diff --git a/docs/man/man1/oc-process.1 b/docs/man/man1/oc-process.1 index 0d8f9ec692ab..1ddf8c8f54f6 100644 --- a/docs/man/man1/oc-process.1 +++ b/docs/man/man1/oc-process.1 @@ -16,13 +16,10 @@ oc process \- Process a template into list of resources Process template into a list of resources specified in filename or stdin .PP -Templates allow parameterization of resources prior to being sent to the server for creation or -update. Templates have "parameters", which may either be generated on creation or set by the user, -as well as metadata describing the template. +Templates allow parameterization of resources prior to being sent to the server for creation orupdate. Templates have "parameters", which may either be generated on creation or set by the user,as well as metadata describing the template. .PP -The output of the process command is always a list of one or more resources. You may pipe the -output to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. +The output of the process command is always a list of one or more resources. You may pipe theoutput to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. .SH OPTIONS @@ -133,19 +130,19 @@ output to the create command over STDIN (using the '\-f \-' option) or redirect .nf # Convert template.json file into resource list and pass to create oc process \-f template.json | oc create \-f \- - + # Process template while passing a user\-defined label oc process \-f template.json \-l name=mytemplate - + # Convert stored template into resource list oc process foo - + # Convert stored template into resource list by setting/overriding parameter values oc process foo PARM1=VALUE1 PARM2=VALUE2 - + # Convert template stored in different namespace into a resource list oc process openshift//foo - + # Convert template.json into resource list cat template.json | oc process \-f \- diff --git a/docs/man/man1/oc-project.1 b/docs/man/man1/oc-project.1 index 380c2040fff4..565a42ef056d 100644 --- a/docs/man/man1/oc-project.1 +++ b/docs/man/man1/oc-project.1 @@ -16,16 +16,10 @@ oc project \- Switch to another project Switch to another project and make it the default in your configuration .PP -If no project was specified on the command line, display information about the current active -project. Since you can use this command to connect to projects on different servers, you will -occasionally encounter projects of the same name on different servers. When switching to that -project, a new local context will be created that will have a unique name \- for instance, -'myapp\-2'. If you have previously created a context with a different name than the project -name, this command will accept that context name instead. +If no project was specified on the command line, display information about the current activeproject. Since you can use this command to connect to projects on different servers, you willoccasionally encounter projects of the same name on different servers. When switching to thatproject, a new local context will be created that will have a unique name \- for instance,'myapp\-2'. If you have previously created a context with a different name than the projectname, this command will accept that context name instead. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config'command. .SH OPTIONS @@ -107,7 +101,7 @@ command. .nf # Switch to 'myapp' project oc project myapp - + # Display the project currently in use oc project diff --git a/docs/man/man1/oc-projects.1 b/docs/man/man1/oc-projects.1 index 6afca2e94851..0dd1f1bf9698 100644 --- a/docs/man/man1/oc-projects.1 +++ b/docs/man/man1/oc-projects.1 @@ -16,8 +16,7 @@ oc projects \- Display existing projects Display information about the current active project and existing projects on the server. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config'command. .SH OPTIONS diff --git a/docs/man/man1/oc-proxy.1 b/docs/man/man1/oc-proxy.1 index 5726423296bd..4d5ca2ab340b 100644 --- a/docs/man/man1/oc-proxy.1 +++ b/docs/man/man1/oc-proxy.1 @@ -135,11 +135,11 @@ Run a proxy to the API server .nf # Run a proxy to the api server on port 8011, serving static content from ./local/www/ oc proxy \-\-port=8011 \-\-www=./local/www/ - + # Run a proxy to the api server on an arbitrary local port. # The chosen port for the server will be output to stdout. oc proxy \-\-port=0 - + # Run a proxy to the api server, changing the api prefix to my\-api # This makes e.g. the pods api available at localhost:8011/my\-api/api/v1/pods/ oc proxy \-\-api\-prefix=/my\-api diff --git a/docs/man/man1/oc-replace.1 b/docs/man/man1/oc-replace.1 index 221d639351aa..dbc16a9c5a7e 100644 --- a/docs/man/man1/oc-replace.1 +++ b/docs/man/man1/oc-replace.1 @@ -142,10 +142,10 @@ JSON and YAML formats are accepted. .nf # Replace a pod using the data in pod.json. oc replace \-f pod.json - + # Replace a pod based on the JSON passed into stdin. cat pod.json | oc replace \-f \- - + # Force replace, delete and then re\-create the resource oc replace \-\-force \-f pod.json diff --git a/docs/man/man1/oc-rollback.1 b/docs/man/man1/oc-rollback.1 index 6fbf136d1adf..b628635bd061 100644 --- a/docs/man/man1/oc-rollback.1 +++ b/docs/man/man1/oc-rollback.1 @@ -16,24 +16,13 @@ oc rollback \- Revert part of an application back to a previous deployment Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated tomatch a previous deployment. By default only the pod and containerconfiguration will be changed and scaling or trigger settings will be left as\-is. Note that environment variables and volumes are included in rollbacks, soif you've recently updated security credentials in your environment yourprevious deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy' command. +Any image triggers present in the rolled back configuration will be disabledwith a warning. This is to help prevent your rolled back deployment from beingreplaced by a triggered deployment soon after your rollback. To re\-enable thetriggers, use the 'deploy' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to printa human\-readable representation of the updated deployment configuration instead ofexecuting the rollback. This is useful if you're not quite sure what the outcomewill be. .SH OPTIONS @@ -139,13 +128,13 @@ will be. .nf # Perform a rollback to the last successfully completed deployment for a deploymentconfig oc rollback frontend - + # See what a rollback to version 3 will look like, but don't perform the rollback oc rollback frontend \-\-to\-version=3 \-\-dry\-run - + # Perform a rollback to a specific deployment oc rollback frontend\-2 - + # Perform the rollback manually by piping the JSON of the new config back to oc oc rollback frontend \-o json | oc replace dc/frontend \-f \- diff --git a/docs/man/man1/oc-rollout-history.1 b/docs/man/man1/oc-rollout-history.1 index 2e89a02e1374..99b51835895b 100644 --- a/docs/man/man1/oc-rollout-history.1 +++ b/docs/man/man1/oc-rollout-history.1 @@ -16,8 +16,7 @@ oc rollout history \- View rollout history View the history of rollouts for a specific deployment config .PP -You can also view more detailed information for a specific revision -by using the \-\-revision flag. +You can also view more detailed information for a specific revisionby using the \-\-revision flag. .SH OPTIONS @@ -107,7 +106,7 @@ by using the \-\-revision flag. .nf # View the rollout history of a deployment oc rollout history dc/nginx - + # View the details of deployment revision 3 oc rollout history dc/nginx \-\-revision=3 diff --git a/docs/man/man1/oc-rollout-pause.1 b/docs/man/man1/oc-rollout-pause.1 index fac834cbdc7b..9562575813b0 100644 --- a/docs/man/man1/oc-rollout-pause.1 +++ b/docs/man/man1/oc-rollout-pause.1 @@ -16,8 +16,7 @@ oc rollout pause \- Mark the provided resource as paused Mark the provided resource as paused .PP -Paused resources will not be reconciled by a controller. -Use \\"%[1]s rollout resume\\" to resume a paused resource. +Paused resources will not be reconciled by a controller.Use\\"%[1]s rollout resume\\" to resume a paused resource. .SH OPTIONS diff --git a/docs/man/man1/oc-rollout-resume.1 b/docs/man/man1/oc-rollout-resume.1 index dba8707e1c14..e10fabf42add 100644 --- a/docs/man/man1/oc-rollout-resume.1 +++ b/docs/man/man1/oc-rollout-resume.1 @@ -16,8 +16,7 @@ oc rollout resume \- Resume a paused resource Resume a paused resource .PP -Paused resources will not be reconciled by a controller. By resuming a -resource, we allow it to be reconciled again. +Paused resources will not be reconciled by a controller. By resuming aresource, we allow it to be reconciled again. .SH OPTIONS diff --git a/docs/man/man1/oc-rollout-undo.1 b/docs/man/man1/oc-rollout-undo.1 index e9c169f37007..4d50251fce9c 100644 --- a/docs/man/man1/oc-rollout-undo.1 +++ b/docs/man/man1/oc-rollout-undo.1 @@ -16,24 +16,13 @@ oc rollout undo \- Undo a previous rollout Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated tomatch a previous deployment. By default only the pod and containerconfiguration will be changed and scaling or trigger settings will be left as\-is. Note that environment variables and volumes are included in rollbacks, soif you've recently updated security credentials in your environment yourprevious deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy \-\-enable\-triggers' command. +Any image triggers present in the rolled back configuration will be disabledwith a warning. This is to help prevent your rolled back deployment from beingreplaced by a triggered deployment soon after your rollback. To re\-enable thetriggers, use the 'deploy \-\-enable\-triggers' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to printa human\-readable representation of the updated deployment configuration instead ofexecuting the rollback. This is useful if you're not quite sure what the outcomewill be. .SH OPTIONS @@ -123,7 +112,7 @@ will be. .nf # Rollback to the previous deployment oc rollout undo dc/nginx - + # Rollback to deployment revision 3. The replication controller for that version must exist. oc rollout undo dc/nginx \-\-to\-revision=3 diff --git a/docs/man/man1/oc-rsh.1 b/docs/man/man1/oc-rsh.1 index 10e73ab42fd4..0f241806cfcd 100644 --- a/docs/man/man1/oc-rsh.1 +++ b/docs/man/man1/oc-rsh.1 @@ -16,20 +16,10 @@ oc rsh \- Start a shell session in a pod Open a remote shell session to a container .PP -This command will attempt to start a shell session in a pod for the specified resource. -It works with pods, deployment configs, jobs, daemon sets, and replication controllers. -Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. -It will default to the first container if none is specified, and will attempt to use -'/bin/sh' as the default shell. You may pass any flags supported by this command before -the resource name, and an optional command after the resource name, which will be executed -instead of a login shell. A TTY will be automatically allocated if standard input is -interactive \- use \-t and \-T to override. A TERM variable is sent to the environment where -the shell (or command) will be executed. By default its value is the same as the TERM -variable from the local environment; if not set, 'xterm' is used. +This command will attempt to start a shell session in a pod for the specified resource.It works with pods, deployment configs, jobs, daemon sets, and replication controllers.Any of the aforementioned resources (apart from pods) will be resolved to a ready pod.It will default to the first container if none is specified, and will attempt to use'/bin/sh' as the default shell. You may pass any flags supported by this command beforethe resource name, and an optional command after the resource name, which will be executedinstead of a login shell. A TTY will be automatically allocated if standard input isinteractive \- use \-t and \-T to override. A TERM variable is sent to the environment wherethe shell (or command) will be executed. By default its value is the same as the TERMvariable from the local environment; if not set, 'xterm' is used. .PP -Note, some containers may not include a shell \- use 'oc exec' if you need to run commands -directly. +Note, some containers may not include a shell \- use 'oc exec' if you need to run commandsdirectly. .SH OPTIONS @@ -125,16 +115,15 @@ directly. .RS .nf - # Open a shell session on the first container in pod 'foo' oc rsh foo - + # Run the command 'cat /etc/resolv.conf' inside pod 'foo' oc rsh foo cat /etc/resolv.conf - + # See the configuration of your internal registry oc rsh dc/docker\-registry cat config.yml - + # Open a shell session on the container named 'index' inside a pod of your job # oc rsh \-c index job/sheduled diff --git a/docs/man/man1/oc-rsync.1 b/docs/man/man1/oc-rsync.1 index 7159f40834d7..ae347c911077 100644 --- a/docs/man/man1/oc-rsync.1 +++ b/docs/man/man1/oc-rsync.1 @@ -16,16 +16,10 @@ oc rsync \- Copy files between local filesystem and a pod Copy local files to or from a pod container .PP -This command will copy local files to or from a remote container. -It only copies the changed files using the rsync command from your OS. -To ensure optimum performance, install rsync locally. In UNIX systems, -use your package manager. In Windows, install cwRsync from - -\[la]https://www.itefix.net/cwrsync\[ra]. +This command will copy local files to or from a remote container.It only copies the changed files using the rsync command from your OS.To ensure optimum performance, install rsync locally. In UNIX systems,use your package manager. In Windows, install cwRsync fromhttps://www.itefix.net/cwrsync. .PP -If no container is specified, the first container of the pod is used -for the copy. +If no container is specified, the first container of the pod is usedfor the copy. .SH OPTIONS @@ -137,10 +131,9 @@ for the copy. .RS .nf - # Synchronize a local directory with a pod directory oc rsync ./local/dir/ POD:/remote/dir - + # Synchronize a pod directory with a local directory oc rsync POD:/remote/dir/ ./local/dir diff --git a/docs/man/man1/oc-run.1 b/docs/man/man1/oc-run.1 index 6c2e22cdb6b0..a660540fdd5a 100644 --- a/docs/man/man1/oc-run.1 +++ b/docs/man/man1/oc-run.1 @@ -16,9 +16,7 @@ oc run \- Run a particular image on the cluster Create and run a particular image, possibly replicated .PP -Creates a deployment config to manage the created container(s). You can choose to run in the -foreground for an interactive container execution. You may pass 'run/v1' to -\-\-generator to create a replication controller instead of a deployment config. +Creates a deployment config to manage the created container(s). You can choose to run in theforeground for an interactive container execution. You may pass 'run/v1' to\-\-generator to create a replication controller instead of a deployment config. .SH OPTIONS @@ -236,17 +234,17 @@ foreground for an interactive container execution. You may pass 'run/v1' to .nf # Starts a single instance of nginx. oc run nginx \-\-image=nginx - + # Starts a replicated instance of nginx. oc run nginx \-\-image=nginx \-\-replicas=5 - + # Dry run. Print the corresponding API objects without creating them. oc run nginx \-\-image=nginx \-\-dry\-run - + # Start a single instance of nginx, but overload the spec of the replication # controller with a partial set of values parsed from JSON. oc run nginx \-\-image=nginx \-\-overrides='{ "apiVersion": "v1", "spec": { ... } }' - + # Start a single instance of nginx and keep it in the foreground, don't restart it if it exits. oc run \-i \-\-tty nginx \-\-image=nginx \-\-restart=Never diff --git a/docs/man/man1/oc-scale.1 b/docs/man/man1/oc-scale.1 index da0fa7dfd2ef..2aad72147f09 100644 --- a/docs/man/man1/oc-scale.1 +++ b/docs/man/man1/oc-scale.1 @@ -16,14 +16,10 @@ oc scale \- Change the number of pods in a deployment Set a new size for a deployment or replication controller .PP -Scale also allows users to specify one or more preconditions for the scale action. -If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the -scale is attempted, and it is guaranteed that the precondition holds true when the -scale is sent to the server. +Scale also allows users to specify one or more preconditions for the scale action.If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before thescale is attempted, and it is guaranteed that the precondition holds true when thescale is sent to the server. .PP -Note that scaling a deployment configuration with no deployments will update the -desired replicas in the configuration template. +Note that scaling a deployment configuration with no deployments will update thedesired replicas in the configuration template. .SH OPTIONS @@ -137,10 +133,10 @@ desired replicas in the configuration template. .nf # Scale replication controller named 'foo' to 3. oc scale \-\-replicas=3 replicationcontrollers foo - + # If the replication controller named foo's current size is 2, scale foo to 3. oc scale \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers foo - + # Scale the latest deployment of 'bar'. In case of no deployment, bar's template # will be scaled instead. oc scale \-\-replicas=10 dc bar diff --git a/docs/man/man1/oc-secrets-add.1 b/docs/man/man1/oc-secrets-add.1 index 8e6d007ed75f..f269851b8359 100644 --- a/docs/man/man1/oc-secrets-add.1 +++ b/docs/man/man1/oc-secrets-add.1 @@ -95,10 +95,10 @@ DEPRECATED: This command has been moved to "oc secrets link" .nf # Add an image pull secret to a service account to automatically use it for pulling pod images: oc serviceaccount\-name pull\-secret \-\-for=pull - + # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images: oc builder builder\-image\-secret \-\-for=pull,mount - + # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod: oc pod\-sa pod\-secret diff --git a/docs/man/man1/oc-secrets-link.1 b/docs/man/man1/oc-secrets-link.1 index 5925e445d685..f3349325f3b6 100644 --- a/docs/man/man1/oc-secrets-link.1 +++ b/docs/man/man1/oc-secrets-link.1 @@ -16,7 +16,7 @@ oc secrets link \- Link secrets to a ServiceAccount Link secrets to a service account .PP -Linking a secret enables a service account to automatically use that secret for some forms of authentication +Linking a secret enables a service account to automatically use that secret for some forms of authentication. .SH OPTIONS @@ -98,10 +98,10 @@ Linking a secret enables a service account to automatically use that secret for .nf # Add an image pull secret to a service account to automatically use it for pulling pod images: oc secrets link serviceaccount\-name pull\-secret \-\-for=pull - + # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images: oc secrets link builder builder\-image\-secret \-\-for=pull,mount - + # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod: oc secrets link pod\-sa pod\-secret diff --git a/docs/man/man1/oc-secrets-new-basicauth.1 b/docs/man/man1/oc-secrets-new-basicauth.1 index 1119bbcd024e..f22505ff0e95 100644 --- a/docs/man/man1/oc-secrets-new-basicauth.1 +++ b/docs/man/man1/oc-secrets-new-basicauth.1 @@ -19,9 +19,7 @@ Create a new basic authentication secret Basic authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires basic authentication \- username, password. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide -this information by creating a 'basicauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires basic authentication \- username, password.In order for the nodes to clone source code on your behalf, they have to have the credentials. You can providethis information by creating a 'basicauth' secret and attaching it to your service account. .SH OPTIONS @@ -149,13 +147,13 @@ this information by creating a 'basicauth' secret and attaching it to your servi .RS .nf - // If your basic authentication method requires only username and password or token, add it by using: + # If your basic authentication method requires only username and password or token, add it by using: oc secrets new\-basicauth SECRET \-\-username=USERNAME \-\-password=PASSWORD - - // If your basic authentication method requires also CA certificate, add it by using: + + # If your basic authentication method requires also CA certificate, add it by using: oc secrets new\-basicauth SECRET \-\-username=USERNAME \-\-password=PASSWORD \-\-ca\-cert=FILENAME - - // If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: + + # If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: oc secrets new SECRET path/to/.gitconfig .fi diff --git a/docs/man/man1/oc-secrets-new-dockercfg.1 b/docs/man/man1/oc-secrets-new-dockercfg.1 index 146823359723..6fd9b18adecf 100644 --- a/docs/man/man1/oc-secrets-new-dockercfg.1 +++ b/docs/man/man1/oc-secrets-new-dockercfg.1 @@ -19,15 +19,10 @@ Create a new dockercfg secret Dockercfg secrets are used to authenticate against Docker registries. .PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. +When using the Docker command line to push images, you can authenticate to a given registry by running'docker login DOCKERREGISTRYSERVER \-\-username=DOCKERUSER \-\-password=DOCKERPASSWORD \-\-email=DOCKER\_EMAIL'.That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands toauthenticate to the registry. .PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. +When creating applications, you may have a Docker registry that requires authentication. In order for thenodes to pull images on your behalf, they have to have the credentials. You can provide this informationby creating a dockercfg secret and attaching it to your service account. .SH OPTIONS @@ -154,13 +149,13 @@ by creating a dockercfg secret and attaching it to your service account. .nf # Create a new .dockercfg secret: oc secrets new\-dockercfg SECRET \-\-docker\-server=DOCKER\_REGISTRY\_SERVER \-\-docker\-username=DOCKER\_USER \-\-docker\-password=DOCKER\_PASSWORD \-\-docker\-email=DOCKER\_EMAIL - + # Create a new .dockercfg secret from an existing file: oc secrets new SECRET path/to/.dockercfg - + # Create a new .docker/config.json secret from an existing file: oc secrets new SECRET .dockerconfigjson=path/to/.docker/config.json - + # To add new secret to 'imagePullSecrets' for the node, or 'secrets' for builds, use: oc edit SERVICE\_ACCOUNT diff --git a/docs/man/man1/oc-secrets-new-sshauth.1 b/docs/man/man1/oc-secrets-new-sshauth.1 index fa965c744c7f..5f50145b3fbe 100644 --- a/docs/man/man1/oc-secrets-new-sshauth.1 +++ b/docs/man/man1/oc-secrets-new-sshauth.1 @@ -19,9 +19,7 @@ Create a new SSH authentication secret SSH authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can -provide this information by creating a 'sshauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key.In order for the nodes to clone source code on your behalf, they have to have the credentials. You canprovide this information by creating a 'sshauth' secret and attaching it to your service account. .SH OPTIONS @@ -141,13 +139,13 @@ provide this information by creating a 'sshauth' secret and attaching it to your .RS .nf - // If your SSH authentication method requires only private SSH key, add it by using: + # If your SSH authentication method requires only private SSH key, add it by using: oc secrets new\-sshauth SECRET \-\-ssh\-privatekey=FILENAME - - // If your SSH authentication method requires also CA certificate, add it by using: + + # If your SSH authentication method requires also CA certificate, add it by using: oc secrets new\-sshauth SECRET \-\-ssh\-privatekey=FILENAME \-\-ca\-cert=FILENAME - - // If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: + + # If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: oc secrets new SECRET path/to/.gitconfig .fi diff --git a/docs/man/man1/oc-secrets-new.1 b/docs/man/man1/oc-secrets-new.1 index 4f66d7a542b3..91afc4892d12 100644 --- a/docs/man/man1/oc-secrets-new.1 +++ b/docs/man/man1/oc-secrets-new.1 @@ -16,9 +16,7 @@ oc secrets new \- Create a new secret based on a key file or on files within a d Create a new secret based on a file or directory .PP -Key files can be specified using their file path, in which case a default name will be given to them, or optionally -with a name and file path, in which case the given name will be used. Specifying a directory will create a secret -using with all valid keys in that directory. +Key files can be specified using their file path, in which case a default name will be given to them, or optionallywith a name and file path, in which case the given name will be used. Specifying a directory will create a secretusing with all valid keys in that directory. .SH OPTIONS @@ -140,16 +138,16 @@ using with all valid keys in that directory. .nf # Create a new secret named my\-secret with a key named ssh\-privatekey oc secrets new my\-secret \~/.ssh/ssh\-privatekey - + # Create a new secret named my\-secret with keys named ssh\-privatekey and ssh\-publickey instead of the names of the keys on disk oc secrets new my\-secret ssh\-privatekey=\~/.ssh/id\_rsa ssh\-publickey=\~/.ssh/id\_rsa.pub - + # Create a new secret named my\-secret with keys for each file in the folder "bar" oc secrets new my\-secret path/to/bar - + # Create a new .dockercfg secret named my\-secret oc secrets new my\-secret path/to/.dockercfg - + # Create a new .docker/config.json secret named my\-secret oc secrets new my\-secret .dockerconfigjson=path/to/.docker/config.json diff --git a/docs/man/man1/oc-secrets-unlink.1 b/docs/man/man1/oc-secrets-unlink.1 index 4dd7c5ca889f..a632908c9fa5 100644 --- a/docs/man/man1/oc-secrets-unlink.1 +++ b/docs/man/man1/oc-secrets-unlink.1 @@ -90,8 +90,8 @@ If a secret is no longer valid for a pod, build or image pull, you may unlink it .RS .nf - # Unlink a secret currently associated with a service account: -oc secrets unlink serviceaccount\-name secret\-name another\-secret\-name ... + # Unlink a secret currently associated with a service account: + oc secrets unlink serviceaccount\-name secret\-name another\-secret\-name ... .fi .RE diff --git a/docs/man/man1/oc-secrets.1 b/docs/man/man1/oc-secrets.1 index 1c74aba4b1d5..a354fd619198 100644 --- a/docs/man/man1/oc-secrets.1 +++ b/docs/man/man1/oc-secrets.1 @@ -16,9 +16,7 @@ oc secrets \- Manage secrets Manage secrets in your project .PP -Secrets are used to store confidential information that should not be contained inside of an image. -They are commonly used to hold things like keys for authentication to other internal systems like -Docker registries. +Secrets are used to store confidential information that should not be contained inside of an image.They are commonly used to hold things like keys for authentication to other internal systems likeDocker registries. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-serviceaccounts-get-token.1 b/docs/man/man1/oc-serviceaccounts-get-token.1 index 5806a2f10186..1eaa3d6e05ac 100644 --- a/docs/man/man1/oc-serviceaccounts-get-token.1 +++ b/docs/man/man1/oc-serviceaccounts-get-token.1 @@ -19,9 +19,7 @@ Get a token assigned to a service account. If the service account has multiple tokens, the first token found will be returned. .PP -Service account API tokens are used by service accounts to authenticate to the API. -Client actions using a service account token will be executed as if the service account -itself were making the actions. +Service account API tokens are used by service accounts to authenticate to the API.Client actions using a service account token will be executed as if the service accountitself were making the actions. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -98,7 +96,6 @@ itself were making the actions. # Get the service account token from service account 'default' oc serviceaccounts get\-token 'default' - .fi .RE diff --git a/docs/man/man1/oc-serviceaccounts-new-token.1 b/docs/man/man1/oc-serviceaccounts-new-token.1 index 18847fe186b0..8294e0c4576d 100644 --- a/docs/man/man1/oc-serviceaccounts-new-token.1 +++ b/docs/man/man1/oc-serviceaccounts-new-token.1 @@ -16,11 +16,7 @@ oc serviceaccounts new\-token \- Generate a new token for a service account. Generate a new token for a service account. .PP -Service account API tokens are used by service accounts to authenticate to the API. -This command will generate a new token, which could be used to compartmentalize service -account actions by executing them with distinct tokens, to rotate out pre\-existing token -on the service account, or for use by an external client. If a label is provided, it will -be applied to any created token so that tokens created with this command can be idenitifed. +Service account API tokens are used by service accounts to authenticate to the API.This command will generate a new token, which could be used to compartmentalize serviceaccount actions by executing them with distinct tokens, to rotate out pre\-existing tokenon the service account, or for use by an external client. If a label is provided, it willbe applied to any created token so that tokens created with this command can be idenitifed. .SH OPTIONS @@ -106,12 +102,11 @@ be applied to any created token so that tokens created with this command can be .nf # Generate a new token for service account 'default' oc serviceaccounts new\-token 'default' - + # Generate a new token for service account 'default' and apply # labels 'foo' and 'bar' to the new token for identification # oc serviceaccounts new\-token 'default' \-\-labels foo=foo\-value,bar=bar\-value - .fi .RE diff --git a/docs/man/man1/oc-set-build-hook.1 b/docs/man/man1/oc-set-build-hook.1 index f3a4ba7fbfe5..26762a1436ae 100644 --- a/docs/man/man1/oc-set-build-hook.1 +++ b/docs/man/man1/oc-set-build-hook.1 @@ -19,17 +19,10 @@ Set or remove a build hook on a build config Build hooks allow behavior to be injected into the build process. .PP -A post\-commit build hook is executed after a build has committed an image but before the -image has been pushed to a registry. It can be used to execute tests on the image and verify -it before it is made available in a registry or for any other logic that is needed to execute -before the image is pushed to the registry. A new container with the recently built image is -launched with the build hook command. If the command or script run by the build hook returns a -non\-zero exit code, the resulting image will not be pushed to the registry. +A post\-commit build hook is executed after a build has committed an image but before theimage has been pushed to a registry. It can be used to execute tests on the image and verifyit before it is made available in a registry or for any other logic that is needed to executebefore the image is pushed to the registry. A new container with the recently built image islaunched with the build hook command. If the command or script run by the build hook returns anon\-zero exit code, the resulting image will not be pushed to the registry. .PP -The command for a build hook may be specified as a shell script (with the \-\-script argument), -as a new entrypoint command on the image with the \-\-command argument, or as a set of -arguments to the image's entrypoint (default). +The command for a build hook may be specified as a shell script (with the \-\-script argument),as a new entrypoint command on the image with the \-\-command argument, or as a set ofarguments to the image's entrypoint (default). .SH OPTIONS @@ -167,13 +160,13 @@ arguments to the image's entrypoint (default). .nf # Clear post\-commit hook on a build config oc set build\-hook bc/mybuild \-\-post\-commit \-\-remove - + # Set the post\-commit hook to execute a test suite using a new entrypoint oc set build\-hook bc/mybuild \-\-post\-commit \-\-command \-\- /bin/bash \-c /var/lib/test\-image.sh - + # Set the post\-commit hook to execute a shell script oc set build\-hook bc/mybuild \-\-post\-commit \-\-script="/var/lib/test\-image.sh param1 param2 \&\& /var/lib/done.sh" - + # Set the post\-commit hook as a set of arguments to the default image entrypoint oc set build\-hook bc/mybuild \-\-post\-commit \-\- arg1 arg2 diff --git a/docs/man/man1/oc-set-deployment-hook.1 b/docs/man/man1/oc-set-deployment-hook.1 index 7078c91f64d1..5beaaf209ce2 100644 --- a/docs/man/man1/oc-set-deployment-hook.1 +++ b/docs/man/man1/oc-set-deployment-hook.1 @@ -16,29 +16,19 @@ oc set deployment\-hook \- Update a deployment hook on a deployment config Set or remove a deployment hook on a deployment config .PP -Deployment configs allow hooks to execute at different points in the lifecycle of the -deployment, depending on the deployment strategy. +Deployment configs allow hooks to execute at different points in the lifecycle of thedeployment, depending on the deployment strategy. .PP -For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified. -The Pre hook will execute before the deployment starts. The Mid hook will execute once the -previous deployment has been scaled down to 0, but before the new one ramps up. -The Post hook will execute once the deployment has completed. +For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified.The Pre hook will execute before the deployment starts. The Mid hook will execute once theprevious deployment has been scaled down to 0, but before the new one ramps up.The Post hook will execute once the deployment has completed. .PP -For deployments with a Rolling strategy, a Pre and Post hook can be specified. -The Pre hook will execute before the deployment starts and the Post hook will execute once -the deployment has completed. +For deployments with a Rolling strategy, a Pre and Post hook can be specified.The Pre hook will execute before the deployment starts and the Post hook will execute oncethe deployment has completed. .PP -For each hook, a new pod will be started using one of the containers in the deployment's pod -template with a specific command to execute. Additional environment variables may be specified -for the hook, as well as which volumes from the pod template will be mounted on the hook pod. +For each hook, a new pod will be started using one of the containers in the deployment's podtemplate with a specific command to execute. Additional environment variables may be specifiedfor the hook, as well as which volumes from the pod template will be mounted on the hook pod. .PP -Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellation -policies can be set on all hooks. For example, a Post hook on a rolling strategy does not support -the abort policy, because at that point the deployment has already happened. +Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellationpolicies can be set on all hooks. For example, a Post hook on a rolling strategy does not supportthe abort policy, because at that point the deployment has already happened. .SH OPTIONS @@ -192,11 +182,11 @@ the abort policy, because at that point the deployment has already happened. .nf # Clear pre and post hooks on a deployment config oc set deployment\-hook dc/myapp \-\-remove \-\-pre \-\-post - + # Set the pre deployment hook to execute a db migration command for an application # using the data volume from the application oc set deployment\-hook dc/myapp \-\-pre \-v data \-\- /var/lib/migrate\-db.sh - + # Set a mid deployment hook along with additional environment variables oc set deployment\-hook dc/myapp \-\-mid \-v data \-e VAR1=value1 \-e VAR2=value2 \-\- /var/lib/prepare\-deploy.sh diff --git a/docs/man/man1/oc-set-env.1 b/docs/man/man1/oc-set-env.1 index 32ccc55b9d81..a979b96913e8 100644 --- a/docs/man/man1/oc-set-env.1 +++ b/docs/man/man1/oc-set-env.1 @@ -16,17 +16,10 @@ oc set env \- Update environment variables on a pod template Update environment variables on a pod template or a build config .PP -List environment variable definitions in one or more pods, pod templates or build -configuration. -Add, update, or remove container environment variable definitions in one or -more pod templates (within replication controllers or deployment configurations) or -build configurations. -View or modify the environment variable definitions on all containers in the -specified pods or pod templates, or just those that match a wildcard. +List environment variable definitions in one or more pods, pod templates or buildconfiguration.Add, update, or remove container environment variable definitions in one ormore pod templates (within replication controllers or deployment configurations) orbuild configurations.View or modify the environment variable definitions on all containers in thespecified pods or pod templates, or just those that match a wildcard. .PP -If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard env -syntax. +If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard envsyntax. .SH OPTIONS @@ -156,32 +149,32 @@ syntax. .nf # Update deployment 'registry' with a new environment variable oc set env dc/registry STORAGE\_DIR=/local - + # List the environment variables defined on a build config 'sample\-build' oc set env bc/sample\-build \-\-list - + # List the environment variables defined on all pods oc set env pods \-\-all \-\-list - + # Output modified build config in YAML, and does not alter the object on the server oc set env bc/sample\-build STORAGE\_DIR=/data \-o yaml - + # Update all containers in all replication controllers in the project to have ENV=prod oc set env rc \-\-all ENV=prod - + # Import environment from a secret oc set env \-\-from=secret/mysecret dc/myapp - + # Import environment from a config map with a prefix oc set env \-\-from=configmap/myconfigmap \-\-prefix=MYSQL\_ dc/myapp - + # Remove the environment variable ENV from container 'c1' in all deployment configs oc set env dc \-\-all \-\-containers="c1" ENV\- - + # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server oc set env \-f dc.json ENV\- - + # Set some of the local shell environment into a deployment config on the server env | grep RAILS\_ | oc set env \-e \- dc/registry diff --git a/docs/man/man1/oc-set-image.1 b/docs/man/man1/oc-set-image.1 index 0f2a50d82d66..d93f3206edf0 100644 --- a/docs/man/man1/oc-set-image.1 +++ b/docs/man/man1/oc-set-image.1 @@ -151,13 +151,13 @@ Update existing container image(s) of resources. .nf # Set a deployment configs's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. oc set image dc/nginx busybox=busybox nginx=nginx:1.9.1 - + # Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' oc set image deployments,rc nginx=nginx:1.9.1 \-\-all - + # Update image of all containers of daemonset abc to 'nginx:1.9.1' oc set image daemonset abc *=nginx:1.9.1 - + # Print result (in yaml format) of updating nginx container image from local file, without hitting the server oc set image \-f path/to/file.yaml nginx=nginx:1.9.1 \-\-local \-o yaml diff --git a/docs/man/man1/oc-set-probe.1 b/docs/man/man1/oc-set-probe.1 index d332287032ef..bb75e49a321b 100644 --- a/docs/man/man1/oc-set-probe.1 +++ b/docs/man/man1/oc-set-probe.1 @@ -16,13 +16,7 @@ oc set probe \- Update a probe on a pod template Set or remove a liveness or readiness probe from a pod or pod template .PP -Each container in a pod may define one or more probes that are used for general health -checking. A liveness probe is checked periodically to ensure the container is still healthy: -if the probe fails, the container is restarted. Readiness probes set or clear the ready -flag for each container, which controls whether the container's ports are included in the list -of endpoints for a service and whether a deployment can proceed. A readiness check should -indicate when your container is ready to accept incoming traffic or begin handling work. -Setting both liveness and readiness probes for each container is highly recommended. +Each container in a pod may define one or more probes that are used for general healthchecking. A liveness probe is checked periodically to ensure the container is still healthy:if the probe fails, the container is restarted. Readiness probes set or clear the readyflag for each container, which controls whether the container's ports are included in the listof endpoints for a service and whether a deployment can proceed. A readiness check shouldindicate when your container is ready to accept incoming traffic or begin handling work.Setting both liveness and readiness probes for each container is highly recommended. .PP The three probe types are: @@ -35,9 +29,7 @@ The three probe types are: .IP \(bu Run a command in the container that must return exit code 0 .PP -Containers that take a variable amount of time to start should set generous -initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin -to fail. +Containers that take a variable amount of time to start should set generousinitial\-delay\-seconds values, otherwise as your application evolves you may suddenly beginto fail. .SH OPTIONS @@ -203,19 +195,19 @@ to fail. .nf # Clear both readiness and liveness probes off all containers oc set probe dc/registry \-\-remove \-\-readiness \-\-liveness - + # Set an exec action as a liveness probe to run 'echo ok' oc set probe dc/registry \-\-liveness \-\- echo ok - + # Set a readiness probe to try to open a TCP socket on 3306 oc set probe rc/mysql \-\-readiness \-\-open\-tcp=3306 - + # Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP oc set probe dc/webapp \-\-readiness \-\-get\-url=http://:8080/healthz - + # Set an HTTP readiness probe over HTTPS on 127.0.0.1 for a hostNetwork pod oc set probe dc/router \-\-readiness \-\-get\-url=https://127.0.0.1:1936/stats - + # Set only the initial\-delay\-seconds field on all deployments oc set probe dc \-\-all \-\-readiness \-\-initial\-delay\-seconds=30 diff --git a/docs/man/man1/oc-set-route-backends.1 b/docs/man/man1/oc-set-route-backends.1 index 4c09918acfa2..1d8afb05f39a 100644 --- a/docs/man/man1/oc-set-route-backends.1 +++ b/docs/man/man1/oc-set-route-backends.1 @@ -16,34 +16,19 @@ oc set route\-backends \- Update the backends for a route Set and adjust route backends .PP -Routes may have one or more optional backend services with weights controlling how much -traffic flows to each service. Traffic is assigned proportional to the combined weights -of each backend. A weight of zero means that the backend will receive no traffic. If all -weights are zero the route will not send traffic to any backends. +Routes may have one or more optional backend services with weights controlling how muchtraffic flows to each service. Traffic is assigned proportional to the combined weightsof each backend. A weight of zero means that the backend will receive no traffic. If allweights are zero the route will not send traffic to any backends. .PP -When setting backends, the first backend is the primary and the other backends are -considered alternates. For example: +When setting backends, the first backend is the primary and the other backends areconsidered alternates. For example: .PP -.RS - -.nf $ oc set route\-backends web prod=99 canary=1 -.fi -.RE - .PP -will set the primary backend to service "prod" with a weight of 99 and the first -alternate backend to service "canary" with a weight of 1. This means 99% of traffic will -be sent to the service "prod". +will set the primary backend to service "prod" with a weight of 99 and the firstalternate backend to service "canary" with a weight of 1. This means 99% of traffic willbe sent to the service "prod". .PP -The \-\-adjust flag allows you to alter the weight of an individual service relative to -itself or to the primary backend. Specifying a percentage will adjust the backend -relative to either the primary or the first alternate (if you specify the primary). -If there are other backends their weights will be kept proportional to the changed. +The \-\-adjust flag allows you to alter the weight of an individual service relative toitself or to the primary backend. Specifying a percentage will adjust the backendrelative to either the primary or the first alternate (if you specify the primary).If there are other backends their weights will be kept proportional to the changed. .PP Not all routers may support multiple or weighted backends. @@ -180,19 +165,19 @@ Not all routers may support multiple or weighted backends. .nf # Print the backends on the route 'web' oc set route\-backends web - + # Set two backend services on route 'web' with 2/3rds of traffic going to 'a' oc set route\-backends web a=2 b=1 - + # Increase the traffic percentage going to b by 10% relative to a oc set route\-backends web \-\-adjust b=+10% - + # Set traffic percentage going to b to 10% of the traffic going to a oc set route\-backends web \-\-adjust b=10% - + # Set weight of b to 10 oc set route\-backends web \-\-adjust b=10 - + # Set the weight to all backends to zero oc set route\-backends web \-\-zero diff --git a/docs/man/man1/oc-set-triggers.1 b/docs/man/man1/oc-set-triggers.1 index 98913179ba3b..3e1e488d98c4 100644 --- a/docs/man/man1/oc-set-triggers.1 +++ b/docs/man/man1/oc-set-triggers.1 @@ -16,18 +16,13 @@ oc set triggers \- Update the triggers on a build or deployment config Set or remove triggers for build configs and deployment configs .PP -All build configs and deployment configs may have a set of triggers that result in a new deployment -or build being created. This command enables you to alter those triggers \- making them automatic or -manual, adding new entries, or changing existing entries. +All build configs and deployment configs may have a set of triggers that result in a new deploymentor build being created. This command enables you to alter those triggers \- making them automatic ormanual, adding new entries, or changing existing entries. .PP -Deployments support triggering off of image changes and on config changes. Config changes are any -alterations to the pod template, while image changes will result in the container image value being -updated whenever an image stream tag is updated. +Deployments support triggering off of image changes and on config changes. Config changes are anyalterations to the pod template, while image changes will result in the container image value beingupdated whenever an image stream tag is updated. .PP -Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specific -and generic). The config change trigger for a build config will only trigger the first build. +Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specificand generic). The config change trigger for a build config will only trigger the first build. .SH OPTIONS @@ -189,23 +184,23 @@ and generic). The config change trigger for a build config will only trigger the .nf # Print the triggers on the registry oc set triggers dc/registry - + # Set all triggers to manual oc set triggers dc/registry \-\-manual - + # Enable all automatic triggers oc set triggers dc/registry \-\-auto - + # Reset the GitHub webhook on a build to a new, generated secret oc set triggers bc/webapp \-\-from\-github oc set triggers bc/webapp \-\-from\-webhook - + # Remove all triggers oc set triggers bc/webapp \-\-remove\-all - + # Stop triggering on config change oc set triggers dc/registry \-\-from\-config \-\-remove - + # Add an image trigger to a build config oc set triggers bc/webapp \-\-from\-image=namespace1/image:latest diff --git a/docs/man/man1/oc-set-volumes.1 b/docs/man/man1/oc-set-volumes.1 index 1552624659e7..e1f7970be94e 100644 --- a/docs/man/man1/oc-set-volumes.1 +++ b/docs/man/man1/oc-set-volumes.1 @@ -16,36 +16,23 @@ oc set volumes \- Update volumes on a pod template Update volumes on a pod template .PP -This command can add, update or remove volumes from containers for any object -that has a pod template (deployment configs, replication controllers, or pods). -You can list volumes in pod or any object that has a pod template. You can -specify a single object or multiple, and alter volumes on all containers or -just those that match a given name. +This command can add, update or remove volumes from containers for any objectthat has a pod template (deployment configs, replication controllers, or pods).You can list volumes in pod or any object that has a pod template. You canspecify a single object or multiple, and alter volumes on all containers orjust those that match a given name. .PP -If you alter a volume setting on a deployment config, a deployment will be -triggered. Changing a replication controller will not affect running pods, and -you cannot change a pod's volumes once it has been created. +If you alter a volume setting on a deployment config, a deployment will betriggered. Changing a replication controller will not affect running pods, andyou cannot change a pod's volumes once it has been created. .PP Volume types include: .IP .IP -\(bu emptydir (empty directory) \fIdefault\fP -A directory allocated when the pod is created on a local host, is removed when -the pod is deleted and is not copied across servers +\(bu emptydir (empty directory)default: A directory allocated when the pod iscreated on a local host, is removed when the pod is deleted and is not copiedacross servers .IP -\(bu hostdir (host directory) -A directory with specific path on any host (requires elevated privileges) +\(bu hostdir (host directory): A directory with specific path on any host(requires elevated privileges) .IP -\(bu persistentvolumeclaim or pvc (persistent volume claim) -Link the volume directory in the container to a persistent volume claim you have -allocated by name \- a persistent volume claim is a request to allocate storage. -Note that if your claim hasn't been bound, your pods will not start. +\(bu persistentvolumeclaim or pvc (persistent volume claim): Link the volumedirectory in the container to a persistent volume claim you have allocated byname \- a persistent volume claim is a request to allocate storage. Note thatif your claim hasn't been bound, your pods will not start. .IP -\(bu secret (mounted secret) -Secret volumes mount a named secret to the provided directory. +\(bu secret (mounted secret): Secret volumes mount a named secret to the provideddirectory. .PP For descriptions on other volume types, see \[la]https://docs.openshift.com\[ra] @@ -210,27 +197,27 @@ For descriptions on other volume types, see .nf # List volumes defined on all deployment configs in the current project oc set volume dc \-\-all - + # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry oc set volume dc/registry \-\-add \-\-mount\-path=/var/lib/registry - + # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' oc set volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-name=pvc1 \-\-overwrite - + # Remove volume 'v1' from deployment config 'registry' oc set volume dc/registry \-\-remove \-\-name=v1 - + # Create a new persistent volume claim that overwrites an existing volume 'v1' oc set volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-size=1G \-\-overwrite - + # Change the mount point for volume 'v1' to /data oc set volume dc/registry \-\-add \-\-name=v1 \-m /data \-\-overwrite - + # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) oc set volume dc/registry \-\-remove \-\-name=v1 \-\-containers=c1 - + # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) oc set volume dc/registry \-\-add \-m /repo \-\-source= diff --git a/docs/man/man1/oc-start-build.1 b/docs/man/man1/oc-start-build.1 index cf29cc568131..9a89d79e0884 100644 --- a/docs/man/man1/oc-start-build.1 +++ b/docs/man/man1/oc-start-build.1 @@ -16,17 +16,10 @@ oc start\-build \- Start a new build Start a build .PP -This command starts a new build for the provided build config or copies an existing build using -\-\-from\-build=. Pass the \-\-follow flag to see output from the build. +This command starts a new build for the provided build config or copies an existing build using\-\-from\-build=. Pass the \-\-follow flag to see output from the build. .PP -In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, -\-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build -and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be -used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the -file is placed in the root of an empty directory with the same filename. Note that builds -triggered from binary input will not preserve the source on the server, so rebuilds triggered by -base image changes will use the source specified on the build config. +In addition, you can pass a file, directory, or source code repository with the \-\-from\-file,\-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the buildand override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can beused to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, thefile is placed in the root of an empty directory with the same filename. Note that buildstriggered from binary input will not preserve the source on the server, so rebuilds triggered bybase image changes will use the source specified on the build config. .SH OPTIONS @@ -160,20 +153,20 @@ base image changes will use the source specified on the build config. .nf # Starts build from build config "hello\-world" oc start\-build hello\-world - + # Starts build from a previous build "hello\-world\-1" oc start\-build \-\-from\-build=hello\-world\-1 - + # Use the contents of a directory as build input oc start\-build hello\-world \-\-from\-dir=src/ - + # Send the contents of a Git repository to the server from tag 'v2' oc start\-build hello\-world \-\-from\-repo=../hello\-world \-\-commit=v2 - + # Start a new build for build config "hello\-world" and watch the logs until the build # completes or fails. oc start\-build hello\-world \-\-follow - + # Start a new build for build config "hello\-world" and wait until the build completes. It # exits with a non\-zero return code if the build fails. oc start\-build hello\-world \-\-wait diff --git a/docs/man/man1/oc-status.1 b/docs/man/man1/oc-status.1 index a3088c84df03..8d48dd2dabea 100644 --- a/docs/man/man1/oc-status.1 +++ b/docs/man/man1/oc-status.1 @@ -16,14 +16,10 @@ oc status \- Show an overview of the current project Show a high level overview of the current project .PP -This command will show services, deployment configs, build configurations, and active deployments. -If you have any misconfigured components information about them will be shown. For more information -about individual items, use the describe command (e.g. oc describe buildConfig, -oc describe deploymentConfig, oc describe service). +This command will show services, deployment configs, build configurations, and active deployments.If you have any misconfigured components information about them will be shown. For more informationabout individual items, use the describe command (e.g. oc describe buildConfig,oc describe deploymentConfig, oc describe service). .PP -You can specify an output format of "\-o dot" to have this command output the generated status -graph in DOT format that is suitable for use by the "dot" command. +You can specify an output format of "\-o dot" to have this command output the generated statusgraph in DOT format that is suitable for use by the "dot" command. .SH OPTIONS @@ -113,10 +109,10 @@ graph in DOT format that is suitable for use by the "dot" command. .nf # See an overview of the current project. oc status - + # Export the overview of the current project in an svg file. oc status \-o dot | dot \-T svg \-o project.svg - + # See an overview of the current project including details for any identified issues. oc status \-v diff --git a/docs/man/man1/oc-tag.1 b/docs/man/man1/oc-tag.1 index f2183afb1468..1fc0930beec4 100644 --- a/docs/man/man1/oc-tag.1 +++ b/docs/man/man1/oc-tag.1 @@ -16,17 +16,10 @@ oc tag \- Tag existing images into image streams Tag existing images into image streams .PP -The tag command allows you to take an existing tag or image from an image -stream, or a Docker image pull spec, and set it as the most recent image for a -tag in 1 or more other image streams. It is similar to the 'docker tag' -command, but it operates on image streams instead. +The tag command allows you to take an existing tag or image from an imagestream, or a Docker image pull spec, and set it as the most recent image for atag in 1 or more other image streams. It is similar to the 'docker tag'command, but it operates on image streams instead. .PP -Pass the \-\-insecure flag if your external registry does not have a valid HTTPS -certificate, or is only served over HTTP. Pass \-\-scheduled to have the server -regularly check the tag for updates and import the latest version (which can -then trigger builds and deployments). Note that \-\-scheduled is only allowed for -Docker images. +Pass the \-\-insecure flag if your external registry does not have a valid HTTPScertificate, or is only served over HTTP. Pass \-\-scheduled to have the serverregularly check the tag for updates and import the latest version (which canthen trigger builds and deployments). Note that \-\-scheduled is only allowed forDocker images. .SH OPTIONS @@ -128,13 +121,13 @@ Docker images. .nf # Tag the current image for the image stream 'openshift/ruby' and tag '2.0' into the image stream 'yourproject/ruby with tag 'tip'. oc tag openshift/ruby:2.0 yourproject/ruby:tip - + # Tag a specific image. oc tag openshift/ruby@sha256:6b646fa6bf5e5e4c7fa41056c27910e679c03ebe7f93e361e6515a9da7e258cc yourproject/ruby:tip - + # Tag an external Docker image. oc tag \-\-source=docker openshift/origin:latest yourproject/ruby:tip - + # Remove the specified spec tag from an image stream. oc tag openshift/origin:latest \-d diff --git a/docs/man/man1/oc-types.1 b/docs/man/man1/oc-types.1 index 0a71899530be..f2a5809e65a1 100644 --- a/docs/man/man1/oc-types.1 +++ b/docs/man/man1/oc-types.1 @@ -16,10 +16,7 @@ oc types \- An introduction to concepts and types Concepts and Types .PP -Kubernetes and OpenShift help developers and operators build, test, and deploy -applications in a containerized cloud environment. Applications may be composed -of all of the components below, although most developers will be concerned with -Services, Deployments, and Builds for delivering changes. +Kubernetes and OpenShift help developers and operators build, test, and deployapplications in a containerized cloud environment. Applications may be composedof all of the components below, although most developers will be concerned withServices, Deployments, and Builds for delivering changes. .PP Concepts: @@ -239,13 +236,13 @@ For more, see .nf # View all projects you have access to oc get projects - + # See a list of all services in the current project oc get svc - + # Describe a deployment configuration in detail oc describe dc mydeploymentconfig - + # Show the images tagged into an image stream oc describe is ruby\-centos7 diff --git a/docs/man/man1/oc-volumes.1 b/docs/man/man1/oc-volumes.1 index d08f4d81ffab..6c837d4e5b0c 100644 --- a/docs/man/man1/oc-volumes.1 +++ b/docs/man/man1/oc-volumes.1 @@ -175,27 +175,27 @@ DEPRECATED: This command has been moved to "oc set volume" .nf # List volumes defined on all deployment configs in the current project oc volume dc \-\-all - + # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry oc volume dc/registry \-\-add \-\-mount\-path=/var/lib/registry - + # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' oc volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-name=pvc1 \-\-overwrite - + # Remove volume 'v1' from deployment config 'registry' oc volume dc/registry \-\-remove \-\-name=v1 - + # Create a new persistent volume claim that overwrites an existing volume 'v1' oc volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-size=1G \-\-overwrite - + # Change the mount point for volume 'v1' to /data oc volume dc/registry \-\-add \-\-name=v1 \-m /data \-\-overwrite - + # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) oc volume dc/registry \-\-remove \-\-name=v1 \-\-containers=c1 - + # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) oc volume dc/registry \-\-add \-m /repo \-\-source= diff --git a/docs/man/man1/oc-whoami.1 b/docs/man/man1/oc-whoami.1 index 04ca30786e25..1d59a7951c0c 100644 --- a/docs/man/man1/oc-whoami.1 +++ b/docs/man/man1/oc-whoami.1 @@ -16,9 +16,7 @@ oc whoami \- Return information about the current session Show information about the current session .PP -The default options for this command will return the currently authenticated user name -or an empty string. Other flags support returning the currently used token or the -user context. +The default options for this command will return the currently authenticated user nameor an empty string. Other flags support returning the currently used token or theuser context. .SH OPTIONS diff --git a/docs/man/man1/oc.1 b/docs/man/man1/oc.1 index 65b973c14cb7..7a4134f7cb3d 100644 --- a/docs/man/man1/oc.1 +++ b/docs/man/man1/oc.1 @@ -16,9 +16,7 @@ oc \- Command line tools for managing applications OpenShift Client .PP -This client helps you develop, build, deploy, and run your applications on any OpenShift or -Kubernetes compatible platform. It also includes the administrative commands for managing a -cluster under the 'adm' subcommand. +This client helps you develop, build, deploy, and run your applications on anyOpenShift or Kubernetes compatible platform. It also includes the administrativecommands for managing a cluster under the 'adm' subcommand. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-build-chain.1 b/docs/man/man1/openshift-admin-build-chain.1 index 0bcd8e8e36cf..199199da1917 100644 --- a/docs/man/man1/openshift-admin-build-chain.1 +++ b/docs/man/man1/openshift-admin-build-chain.1 @@ -16,9 +16,7 @@ openshift admin build\-chain \- Output the inputs and dependencies of your build Output the inputs and dependencies of your builds .PP -Supported formats for the generated graph are dot and a human\-readable output. -Tag and namespace are optional and if they are not specified, 'latest' and the -default namespace will be used respectively. +Supported formats for the generated graph are dot and a human\-readable output.Tag and namespace are optional and if they are not specified, 'latest' and thedefault namespace will be used respectively. .SH OPTIONS @@ -112,10 +110,10 @@ default namespace will be used respectively. .nf # Build the dependency tree for the 'latest' tag in openshift admin build\-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility openshift admin build\-chain :v2 \-o dot | dot \-T svg \-o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace openshift admin build\-chain \-n test \-\-all diff --git a/docs/man/man1/openshift-admin-ca-create-key-pair.1 b/docs/man/man1/openshift-admin-ca-create-key-pair.1 index 6968245b4580..20f8dff5d87d 100644 --- a/docs/man/man1/openshift-admin-ca-create-key-pair.1 +++ b/docs/man/man1/openshift-admin-ca-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -openshift admin ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + openshift admin ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-ca-create-master-certs.1 b/docs/man/man1/openshift-admin-ca-create-master-certs.1 index 53b77b642f22..ba8494c9c464 100644 --- a/docs/man/man1/openshift-admin-ca-create-master-certs.1 +++ b/docs/man/man1/openshift-admin-ca-create-master-certs.1 @@ -16,66 +16,39 @@ openshift admin ca create\-master\-certs \- Create certificates and keys for a m Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -openshift admin ca create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + openshift admin ca create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-ca-create-server-cert.1 b/docs/man/man1/openshift-admin-ca-create-server-cert.1 index 849345f3e06b..ee33c7a2998b 100644 --- a/docs/man/man1/openshift-admin-ca-create-server-cert.1 +++ b/docs/man/man1/openshift-admin-ca-create-server-cert.1 @@ -16,26 +16,18 @@ openshift admin ca create\-server\-cert \- Create a signed server certificate an Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -openshift admin ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + openshift admin ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-ca-decrypt.1 b/docs/man/man1/openshift-admin-ca-decrypt.1 index 9251bc619474..24cd17b5203f 100644 --- a/docs/man/man1/openshift-admin-ca-decrypt.1 +++ b/docs/man/man1/openshift-admin-ca-decrypt.1 @@ -101,12 +101,11 @@ Decrypt data encrypted with "openshift admin ca encrypt" .RS .nf - # Decrypt an encrypted file to a cleartext file: - openshift admin ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - - # Decrypt from stdin to stdout: - openshift admin ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted - + # Decrypt an encrypted file to a cleartext file: + openshift admin ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted + + # Decrypt from stdin to stdout: + openshift admin ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted .fi .RE diff --git a/docs/man/man1/openshift-admin-ca-encrypt.1 b/docs/man/man1/openshift-admin-ca-encrypt.1 index 7c995762b3c1..5ca3126f34b4 100644 --- a/docs/man/man1/openshift-admin-ca-encrypt.1 +++ b/docs/man/man1/openshift-admin-ca-encrypt.1 @@ -105,12 +105,11 @@ Encrypt data with AES\-256\-CBC encryption .RS .nf - # Encrypt the content of secret.txt with a generated key: - openshift admin ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - - # Encrypt the content of secret2.txt with an existing key: - openshift admin ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted - + # Encrypt the content of secret.txt with a generated key: + openshift admin ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted + + # Encrypt the content of secret2.txt with an existing key: + openshift admin ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted .fi .RE diff --git a/docs/man/man1/openshift-admin-completion.1 b/docs/man/man1/openshift-admin-completion.1 index a63b59fcd5d0..593b32474548 100644 --- a/docs/man/man1/openshift-admin-completion.1 +++ b/docs/man/man1/openshift-admin-completion.1 @@ -13,8 +13,7 @@ openshift admin completion \- Output shell completion code for the given shell ( .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift admin commands. +This command prints shell code which must be evaluated to provide interactivecompletion of openshift admin commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -91,18 +90,19 @@ completion of openshift admin commands. # Generate the openshift admin completion code for bash openshift admin completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion openshift admin completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(openshift admin completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/openshift-admin-config-current-context.1 b/docs/man/man1/openshift-admin-config-current-context.1 index d1d0ceffd35f..49698250a39a 100644 --- a/docs/man/man1/openshift-admin-config-current-context.1 +++ b/docs/man/man1/openshift-admin-config-current-context.1 @@ -87,7 +87,6 @@ Displays the current\-context .RS .nf - # Display the current\-context openshift admin config current\-context diff --git a/docs/man/man1/openshift-admin-config-set-cluster.1 b/docs/man/man1/openshift-admin-config-set-cluster.1 index a39d42c33837..1432a20918d2 100644 --- a/docs/man/man1/openshift-admin-config-set-cluster.1 +++ b/docs/man/man1/openshift-admin-config-set-cluster.1 @@ -13,8 +13,7 @@ openshift admin config set\-cluster \- Sets a cluster entry in kubeconfig .SH DESCRIPTION .PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set only the server field on the e2e cluster entry without touching other values. openshift admin config set\-cluster e2e \-\-server=https://1.2.3.4 diff --git a/docs/man/man1/openshift-admin-config-set-context.1 b/docs/man/man1/openshift-admin-config-set-context.1 index 9e9230ee07b2..d71f567517a1 100644 --- a/docs/man/man1/openshift-admin-config-set-context.1 +++ b/docs/man/man1/openshift-admin-config-set-context.1 @@ -13,8 +13,7 @@ openshift admin config set\-context \- Sets a context entry in kubeconfig .SH DESCRIPTION .PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set the user field on the gce context entry without touching other values openshift admin config set\-context gce \-\-user=cluster\-admin diff --git a/docs/man/man1/openshift-admin-config-set-credentials.1 b/docs/man/man1/openshift-admin-config-set-credentials.1 index 84d7afe07372..b225d4a36d9f 100644 --- a/docs/man/man1/openshift-admin-config-set-credentials.1 +++ b/docs/man/man1/openshift-admin-config-set-credentials.1 @@ -13,20 +13,16 @@ openshift admin config set\-credentials \- Sets a user entry in kubeconfig .SH DESCRIPTION .PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. +Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values. .PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile +Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile .PP -Bearer token flags: - \-\-token=bearer\_token +Bearer token flags:\-\-token=bearer\_token .PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password +Basic auth flags:\-\-username=basicuser \-\-password=basicpassword .PP Bearer token and basic auth are mutually exclusive. @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive. .RS .nf - # Set only the "client\-key" field on the "cluster\-admin" # entry, without touching other values: openshift admin config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key diff --git a/docs/man/man1/openshift-admin-config-set.1 b/docs/man/man1/openshift-admin-config-set.1 index a919e5c69120..ca4b915c6341 100644 --- a/docs/man/man1/openshift-admin-config-set.1 +++ b/docs/man/man1/openshift-admin-config-set.1 @@ -13,9 +13,7 @@ openshift admin config set \- Sets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. +Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-config-unset.1 b/docs/man/man1/openshift-admin-config-unset.1 index 2f081f5d4c6b..89482113ffa5 100644 --- a/docs/man/man1/openshift-admin-config-unset.1 +++ b/docs/man/man1/openshift-admin-config-unset.1 @@ -13,8 +13,7 @@ openshift admin config unset \- Unsets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. +Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-config-view.1 b/docs/man/man1/openshift-admin-config-view.1 index c6c3cf1044f8..baed7e444dbd 100644 --- a/docs/man/man1/openshift-admin-config-view.1 +++ b/docs/man/man1/openshift-admin-config-view.1 @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat .RS .nf - # Show Merged kubeconfig settings. openshift admin config view diff --git a/docs/man/man1/openshift-admin-config.1 b/docs/man/man1/openshift-admin-config.1 index 19a5b8d330de..4de5d4ad13d6 100644 --- a/docs/man/man1/openshift-admin-config.1 +++ b/docs/man/man1/openshift-admin-config.1 @@ -16,9 +16,7 @@ openshift admin config \- Change configuration files for the client Manage the client config files .PP -The client stores configuration in the current user's home directory (under the .kube directory as -config). When you login the first time, a new config file is created, and subsequent project changes with the -'project' command will set the current context. These subcommands allow you to manage the config directly. +The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly. .PP Reference: diff --git a/docs/man/man1/openshift-admin-cordon.1 b/docs/man/man1/openshift-admin-cordon.1 index b67a358196e7..2631ad94fa11 100644 --- a/docs/man/man1/openshift-admin-cordon.1 +++ b/docs/man/man1/openshift-admin-cordon.1 @@ -87,10 +87,8 @@ Mark node as unschedulable. .RS .nf - -# Mark node "foo" as unschedulable. -openshift admin cordon foo - + # Mark node "foo" as unschedulable. + openshift admin cordon foo .fi .RE diff --git a/docs/man/man1/openshift-admin-create-api-client-config.1 b/docs/man/man1/openshift-admin-create-api-client-config.1 index ec9acd045e48..0b91d99d203b 100644 --- a/docs/man/man1/openshift-admin-create-api-client-config.1 +++ b/docs/man/man1/openshift-admin-create-api-client-config.1 @@ -16,9 +16,7 @@ openshift admin create\-api\-client\-config \- Create a config file for connecti Create a client configuration for connecting to the server .PP -This command creates a folder containing a client certificate, a client key, -a server certificate authority, and a .kubeconfig file for connecting to the -master as the provided user. +This command creates a folder containing a client certificate, a client key,a server certificate authority, and a .kubeconfig file for connecting to themaster as the provided user. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-create-error-template.1 b/docs/man/man1/openshift-admin-create-error-template.1 index c609e3b41421..d2b67e26debf 100644 --- a/docs/man/man1/openshift-admin-create-error-template.1 +++ b/docs/man/man1/openshift-admin-create-error-template.1 @@ -16,24 +16,15 @@ openshift admin create\-error\-template \- Create an error page template Create a template for customizing the error page .PP -This command creates a basic template to use as a starting point for -customizing the authentication error page. Save the output to a file and edit -the template to change the look and feel or add content. +This command creates a basic template to use as a starting point forcustomizing the authentication error page. Save the output to a file and editthe template to change the look and feel or add content. .PP -To use the template, set oauthConfig.templates.error in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.error in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - error: templates/error.html - -.fi -.RE + templates: + error: templates/error.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-create-key-pair.1 b/docs/man/man1/openshift-admin-create-key-pair.1 index 83c5b7e24da7..92c9b1e57296 100644 --- a/docs/man/man1/openshift-admin-create-key-pair.1 +++ b/docs/man/man1/openshift-admin-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -openshift admin create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + openshift admin create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-create-kubeconfig.1 b/docs/man/man1/openshift-admin-create-kubeconfig.1 index dbcce97d0426..5cac0bfd41de 100644 --- a/docs/man/man1/openshift-admin-create-kubeconfig.1 +++ b/docs/man/man1/openshift-admin-create-kubeconfig.1 @@ -13,36 +13,36 @@ openshift admin create\-kubeconfig \- Create a basic .kubeconfig file from clien .SH DESCRIPTION .PP -Create's a .kubeconfig file at <\-\-kubeconfig> that looks like this: +Create's a .kubeconfig file at<\-\-kubeconfig> that looks like this: .PP clusters: -\- cluster: - certificate\-authority\-data: - server: <\-\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-master> name: <\-\-cluster> -\- cluster: - certificate\-authority\-data: - server: <\-\-public\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-public\-master> name: public\-<\-\-cluster> -contexts: -\- context: - cluster: <\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + contexts: + \- context: + cluster: <\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: <\-\-context> -\- context: - cluster: public\-<\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + \- context: + cluster: public\-<\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: public\-<\-\-context> -current\-context: <\-\-context> -kind: Config -users: -\- name: <\-\-user> + current\-context: <\-\-context> + kind: Config + users: + \- name: <\-\-user> user: - client\-certificate\-data: - client\-key\-data: + client\-certificate\-data: + client\-key\-data: .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-create-login-template.1 b/docs/man/man1/openshift-admin-create-login-template.1 index 69bfded08caa..406e446975d8 100644 --- a/docs/man/man1/openshift-admin-create-login-template.1 +++ b/docs/man/man1/openshift-admin-create-login-template.1 @@ -16,25 +16,15 @@ openshift admin create\-login\-template \- Create a login template Create a template for customizing the login page .PP -This command creates a basic template to use as a starting point for -customizing the login page. Save the output to a file and edit the template to -change the look and feel or add content. Be careful not to remove any parameter -values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login page. Save the output to a file and edit the template tochange the look and feel or add content. Be careful not to remove any parametervalues inside curly braces. .PP -To use the template, set oauthConfig.templates.login in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.login in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - login: templates/login.html - -.fi -.RE + templates: + login: templates/login.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-create-master-certs.1 b/docs/man/man1/openshift-admin-create-master-certs.1 index c982362d4b9e..c1a92659cb8c 100644 --- a/docs/man/man1/openshift-admin-create-master-certs.1 +++ b/docs/man/man1/openshift-admin-create-master-certs.1 @@ -16,66 +16,39 @@ openshift admin create\-master\-certs \- Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -openshift admin create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + openshift admin create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-create-provider-selection-template.1 b/docs/man/man1/openshift-admin-create-provider-selection-template.1 index aea3aa008000..8f5de2e21017 100644 --- a/docs/man/man1/openshift-admin-create-provider-selection-template.1 +++ b/docs/man/man1/openshift-admin-create-provider-selection-template.1 @@ -16,25 +16,15 @@ openshift admin create\-provider\-selection\-template \- Create a provider selec Create a template for customizing the provider selection page .PP -This command creates a basic template to use as a starting point for -customizing the login provider selection page. Save the output to a file and edit -the template to change the look and feel or add content. Be careful not to remove -any parameter values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login provider selection page. Save the output to a file and editthe template to change the look and feel or add content. Be careful not to removeany parameter values inside curly braces. .PP -To use the template, set oauthConfig.templates.providerSelection in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.providerSelection in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - providerSelection: templates/provider\-selection.html - -.fi -.RE + templates: + providerSelection: templates/provider\-selection.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-create-server-cert.1 b/docs/man/man1/openshift-admin-create-server-cert.1 index 8605505c25a5..87b1944b7396 100644 --- a/docs/man/man1/openshift-admin-create-server-cert.1 +++ b/docs/man/man1/openshift-admin-create-server-cert.1 @@ -16,26 +16,18 @@ openshift admin create\-server\-cert \- Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -openshift admin create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + openshift admin create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-diagnostics.1 b/docs/man/man1/openshift-admin-diagnostics.1 index ebdff74d5357..97abd4212ad5 100644 --- a/docs/man/man1/openshift-admin-diagnostics.1 +++ b/docs/man/man1/openshift-admin-diagnostics.1 @@ -13,59 +13,32 @@ openshift admin diagnostics \- Diagnose common cluster problems .SH DESCRIPTION .PP -This utility helps troubleshoot and diagnose known problems. It runs -diagnostics using a client and/or the state of a running master / -node host. +This utility helps troubleshoot and diagnose known problems. It runsdiagnostics using a client and/or the state of a running master /node host. .PP -.RS - -.nf openshift admin diagnostics -.fi -.RE - .PP -If run without flags, it will check for standard config files for -client, master, and node, and if found, use them for diagnostics. -You may also specify config files explicitly with flags, in which case -you will receive an error if they are not found. For example: +If run without flags, it will check for standard config files forclient, master, and node, and if found, use them for diagnostics.You may also specify config files explicitly with flags, in which caseyou will receive an error if they are not found. For example: .PP -.RS - -.nf openshift admin diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml - -.fi -.RE .IP .IP -\(bu If master/node config files are not found and the \-\-host flag is not -present, host diagnostics are skipped. +\(bu If master/node config files are not found and the \-\-host flag is notpresent, host diagnostics are skipped. .IP -\(bu If the client has cluster\-admin access, this access enables cluster -diagnostics to run which regular users cannot. +\(bu If the client has cluster\-admin access, this access enables clusterdiagnostics to run which regular users cannot. .IP -\(bu If a client config file is not found, client and cluster diagnostics -are skipped. +\(bu If a client config file is not found, client and cluster diagnosticsare skipped. .PP Diagnostics may be individually run by passing diagnostic name as arguments. .PP -.RS - -.nf openshift admin diagnostics -.fi -.RE - .PP -The available diagnostic names are: -AggregatedLogging AnalyzeLogs ClusterRegistry ClusterRoleBindings ClusterRoles ClusterRouter ConfigContexts DiagnosticPod MasterConfigCheck MasterNode MetricsApiProxy NodeConfigCheck NodeDefinitions ServiceExternalIPs UnitStatus +The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegistry, ClusterRoleBindings, ClusterRoles, ClusterRouter, ConfigContexts, DiagnosticPod, MasterConfigCheck, MasterNode, MetricsApiProxy, NodeConfigCheck, NodeDefinitions, ServiceExternalIPs, UnitStatus. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-drain.1 b/docs/man/man1/openshift-admin-drain.1 index bb54a9726b2a..ae922a43a5e9 100644 --- a/docs/man/man1/openshift-admin-drain.1 +++ b/docs/man/man1/openshift-admin-drain.1 @@ -16,22 +16,14 @@ openshift admin drain \- Drain node in preparation for maintenance Drain node in preparation for maintenance. .PP -The given node will be marked unschedulable to prevent new pods from arriving. -Then drain deletes all pods except mirror pods (which cannot be deleted through -the API server). If there are DaemonSet\-managed pods, drain will not proceed -without \-\-ignore\-daemonsets, and regardless it will not delete any -DaemonSet\-managed pods, because those pods would be immediately replaced by the -DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed\-\-by ReplicationController, -ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless you -use \-\-force. +The given node will be marked unschedulable to prevent new pods from arriving.Then drain deletes all pods except mirror pods (which cannot be deleted throughthe API server). If there are DaemonSet\-managed pods, drain will not proceedwithout \-\-ignore\-daemonsets, and regardless it will not delete anyDaemonSet\-managed pods, because those pods would be immediately replaced by theDaemonSet controller, which ignores unschedulable markings. If there are anypods that are neither mirror pods nor managed\-\-by ReplicationController,ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless youuse \-\-force. .PP -When you are ready to put the node back into service, use kubectl uncordon, which -will make the node schedulable again. +When you are ready to put the node back into service, use kubectl uncordon, whichwill make the node schedulable again. .PP +\[la]http://kubernetes.io/images/docs/kubectl_drain.svg\[ra] .SH OPTIONS @@ -123,13 +115,11 @@ will make the node schedulable again. .RS .nf - -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ openshift admin drain foo \-\-force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ openshift admin drain foo \-\-grace\-period=900 - + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. + $ openshift admin drain foo \-\-force + + # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. + $ openshift admin drain foo \-\-grace\-period=900 .fi .RE diff --git a/docs/man/man1/openshift-admin-groups-new.1 b/docs/man/man1/openshift-admin-groups-new.1 index 29667e7ec2f7..04ecf179aafd 100644 --- a/docs/man/man1/openshift-admin-groups-new.1 +++ b/docs/man/man1/openshift-admin-groups-new.1 @@ -126,10 +126,10 @@ This command will create a new group with an optional list of users. .nf # Add a group with no users openshift admin groups new my\-group - + # Add a group with two users openshift admin groups new my\-group user1 user2 - + # Add a group with one user and shorter output openshift admin groups new my\-group user1 \-o name diff --git a/docs/man/man1/openshift-admin-groups-prune.1 b/docs/man/man1/openshift-admin-groups-prune.1 index e1d9af538eac..898491c3408a 100644 --- a/docs/man/man1/openshift-admin-groups-prune.1 +++ b/docs/man/man1/openshift-admin-groups-prune.1 @@ -16,13 +16,7 @@ openshift admin groups prune \- Prune OpenShift groups referencing missing recor Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups openshift admin groups prune \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file openshift admin groups prune \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file openshift admin groups prune \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist openshift admin groups prune groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-admin-groups-sync.1 b/docs/man/man1/openshift-admin-groups-sync.1 index b4e14245d503..78fd268397ad 100644 --- a/docs/man/man1/openshift-admin-groups-sync.1 +++ b/docs/man/man1/openshift-admin-groups-sync.1 @@ -16,13 +16,7 @@ openshift admin groups sync \- Sync OpenShift groups with records from an extern Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wishto sync and where their records live. For instance, all or some groups may be selected from the current Groupsstored in OpenShift that have been synced previously, or similarly all or some groups may be selected from thosestored on an LDAP server. The path to a sync configuration file is required in order to describe how data isrequested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-runwithout changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by theLDAP query templates. .SH OPTIONS @@ -152,20 +146,19 @@ LDAP query templates. .nf # Sync all groups from an LDAP server openshift admin groups sync \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server openshift admin groups sync \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific groups specified in a whitelist file with an LDAP server openshift admin groups sync \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server openshift admin groups sync \-\-type=openshift \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server openshift admin groups sync groups/group1 groups/group2 groups/group3 \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-admin-ipfailover.1 b/docs/man/man1/openshift-admin-ipfailover.1 index 7114bf8345fa..731e3e671baa 100644 --- a/docs/man/man1/openshift-admin-ipfailover.1 +++ b/docs/man/man1/openshift-admin-ipfailover.1 @@ -16,17 +16,10 @@ openshift admin ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for thecluster. An administrator can configure IP failover on an entirecluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name,the \-\-create flag can be passed to create a deployment configuration thatwill provide IP failover capability. If you are running in production, it isrecommended that the labeled selector for the nodes matches at least 2 nodesto ensure you have failover protection, and that you provide a \-\-replicas=value that matches the number of nodes for the given labeled selector. .SH OPTIONS @@ -164,18 +157,18 @@ value that matches the number of nodes for the given labeled selector. .nf # Check the default IP failover configuration ("ipfailover"): openshift admin ipfailover - + # See what the IP failover configuration would look like if it is created: openshift admin ipfailover \-o json - + # Create an IP failover configuration if it does not already exist: openshift admin ipfailover ipf \-\-virtual\-ips="10.1.1.1\-4" \-\-create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us\-west\-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). openshift admin ipfailover ipfailover \-\-selector="router=us\-west\-ha" \-\-virtual\-ips="1.2.3.4,10.1.1.100\-104,5.6.7.8" \-\-watch\-port=80 \-\-replicas=4 \-\-create - + # Use a different IP failover config image and see the configuration: openshift admin ipfailover ipf\-alt \-\-selector="hagroup=us\-west\-ha" \-\-virtual\-ips="1.2.3.4" \-o yaml \-\-images=myrepo/myipfailover:mytag diff --git a/docs/man/man1/openshift-admin-manage-node.1 b/docs/man/man1/openshift-admin-manage-node.1 index 39dc6473cff1..437442ff6752 100644 --- a/docs/man/man1/openshift-admin-manage-node.1 +++ b/docs/man/man1/openshift-admin-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node andmarking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - openshift admin manage\-node \-\-schedulable=false - - # Mark selected nodes as schedulable - openshift admin manage\-node \-\-selector="" \-\-schedulable=true - - # Migrate selected pods - openshift admin manage\-node \-\-evacuate \-\-pod\-selector="" - - # Migrate selected pods, use a grace period of 60 seconds - openshift admin manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - - # Migrate selected pods not backed by replication controller - openshift admin manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - - # Show pods that will be migrated - openshift admin manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - - # List all pods on given nodes - openshift admin manage\-node \-\-list\-pods + # Block accepting any pods on given nodes + openshift admin manage\-node \-\-schedulable=false + + # Mark selected nodes as schedulable + openshift admin manage\-node \-\-selector="" \-\-schedulable=true + + # Migrate selected pods + openshift admin manage\-node \-\-evacuate \-\-pod\-selector="" + + # Migrate selected pods, use a grace period of 60 seconds + openshift admin manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + + # Migrate selected pods not backed by replication controller + openshift admin manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + + # Show pods that will be migrated + openshift admin manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + + # List all pods on given nodes + openshift admin manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/openshift-admin-migrate-image-references.1 b/docs/man/man1/openshift-admin-migrate-image-references.1 index 24a995842928..461f2f2d30cb 100644 --- a/docs/man/man1/openshift-admin-migrate-image-references.1 +++ b/docs/man/man1/openshift-admin-migrate-image-references.1 @@ -16,34 +16,35 @@ openshift admin migrate image\-references \- Update embedded Docker image refere Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default itwill update image streams and images, and may be used to update resources with a pod template(deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and thedesired registry and name. Either name or registry can be set to '*' to change all values.The registry value "docker.io" is special and will handle any image reference that refers tothe DockerHub. You may pass multiple mappings \- the first matching mapping will be appliedper resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs .IP -\(bu imagestreams * jobs +\(bu daemonsets .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs .IP -\(bu deploymentconfigs * pods +\(bu images +.IP +\(bu imagestreams +.IP +\(bu jobs +.IP +\(bu pods +.IP +\(bu replicationcontrollers .IP \(bu secrets (docker) .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and imagestreams requires administrative privileges. .SH OPTIONS @@ -149,16 +150,16 @@ streams requires administrative privileges. .nf # Perform a dry\-run of migrating all "docker.io" references to "myregistry.com" openshift admin migrate image\-references docker.io/*=myregistry.com/* - + # To actually perform the migration, the confirm flag must be appended openshift admin migrate image\-references docker.io/*=myregistry.com/* \-\-confirm - + # To see more details of what will be migrated, use the loglevel and output flags openshift admin migrate image\-references docker.io/*=myregistry.com/* \-\-loglevel=2 \-o yaml - + # Migrate from a service IP to an internal service DNS name openshift admin migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* - + # Migrate from a service IP to an internal service DNS name for all deployment configs and builds openshift admin migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* \-\-include=buildconfigs,deploymentconfigs diff --git a/docs/man/man1/openshift-admin-migrate-storage.1 b/docs/man/man1/openshift-admin-migrate-storage.1 index 2f5e34eae891..4ebec708b192 100644 --- a/docs/man/man1/openshift-admin-migrate-storage.1 +++ b/docs/man/man1/openshift-admin-migrate-storage.1 @@ -16,25 +16,16 @@ openshift admin migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forcesthe server to write to the underlying storage if the object representation has changed. Use thiscommand to ensure that the most recent storage changes have been applied to all objects (storageversion, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a runthe command will output a list of resources that received errors, which you can then re\-run thecommand on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource namesto operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scopedresources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If youhave significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may alsoresult in significant intra\-cluster traffic. .SH OPTIONS @@ -140,17 +131,16 @@ WARNING: This is a slow command and will put significant load on an API server. .nf # Perform a dry\-run of updating all objects openshift admin migrate storage - + # To actually perform the update, the confirm flag must be appended openshift admin migrate storage \-\-confirm - + # Only migrate pods openshift admin migrate storage \-\-include=pods \-\-confirm - + # Only pods that are in namespaces starting with "bar" openshift admin migrate storage \-\-include=pods \-\-confirm \-\-from\-key=bar/ \-\-to\-key=bar/\\xFF - .fi .RE diff --git a/docs/man/man1/openshift-admin-new-project.1 b/docs/man/man1/openshift-admin-new-project.1 index bb8127e07eaa..d9c8ecfe6018 100644 --- a/docs/man/man1/openshift-admin-new-project.1 +++ b/docs/man/man1/openshift-admin-new-project.1 @@ -16,9 +16,7 @@ openshift admin new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project,an admin user (and role, if you want to use a non\-default admin role), and a node selectorto restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/openshift-admin-pod-network-isolate-projects.1 b/docs/man/man1/openshift-admin-pod-network-isolate-projects.1 index 9a77236d4855..87b9a91e67a6 100644 --- a/docs/man/man1/openshift-admin-pod-network-isolate-projects.1 +++ b/docs/man/man1/openshift-admin-pod-network-isolate-projects.1 @@ -96,11 +96,11 @@ Allows projects to isolate their network from other projects when using the redh .RS .nf - # Provide isolation for project p1 - openshift admin pod\-network isolate\-projects - - # Allow all projects with label name=top\-secret to have their own isolated project network - openshift admin pod\-network isolate\-projects \-\-selector='name=top\-secret' + # Provide isolation for project p1 + openshift admin pod\-network isolate\-projects + + # Allow all projects with label name=top\-secret to have their own isolated project network + openshift admin pod\-network isolate\-projects \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/openshift-admin-pod-network-join-projects.1 b/docs/man/man1/openshift-admin-pod-network-join-projects.1 index de4d917a3278..42978175ee7e 100644 --- a/docs/man/man1/openshift-admin-pod-network-join-projects.1 +++ b/docs/man/man1/openshift-admin-pod-network-join-projects.1 @@ -100,11 +100,11 @@ Allows projects to join existing project network when using the redhat/openshift .RS .nf - # Allow project p2 to use project p1 network - openshift admin pod\-network join\-projects \-\-to= - - # Allow all projects with label name=top\-secret to use project p1 network - openshift admin pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' + # Allow project p2 to use project p1 network + openshift admin pod\-network join\-projects \-\-to= + + # Allow all projects with label name=top\-secret to use project p1 network + openshift admin pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/openshift-admin-pod-network-make-projects-global.1 b/docs/man/man1/openshift-admin-pod-network-make-projects-global.1 index 84dce1a3c3a0..28693fc9ffc2 100644 --- a/docs/man/man1/openshift-admin-pod-network-make-projects-global.1 +++ b/docs/man/man1/openshift-admin-pod-network-make-projects-global.1 @@ -96,11 +96,11 @@ Allows projects to access all pods in the cluster and vice versa when using the .RS .nf - # Allow project p1 to access all pods in the cluster and vice versa - openshift admin pod\-network make\-projects\-global - - # Allow all projects with label name=share to access all pods in the cluster and vice versa - openshift admin pod\-network make\-projects\-global \-\-selector='name=share' + # Allow project p1 to access all pods in the cluster and vice versa + openshift admin pod\-network make\-projects\-global + + # Allow all projects with label name=share to access all pods in the cluster and vice versa + openshift admin pod\-network make\-projects\-global \-\-selector='name=share' .fi .RE diff --git a/docs/man/man1/openshift-admin-policy-add-role-to-user.1 b/docs/man/man1/openshift-admin-policy-add-role-to-user.1 index 1913b6feba0e..1c9f5b6f6d6e 100644 --- a/docs/man/man1/openshift-admin-policy-add-role-to-user.1 +++ b/docs/man/man1/openshift-admin-policy-add-role-to-user.1 @@ -99,7 +99,7 @@ Add a role to users or serviceaccounts for the current project .nf # Add the 'view' role to user1 for the current project openshift admin policy add\-role\-to\-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project openshift admin policy add\-role\-to\-user edit \-z serviceaccount1 diff --git a/docs/man/man1/openshift-admin-policy-add-scc-to-user.1 b/docs/man/man1/openshift-admin-policy-add-scc-to-user.1 index 80a74fd9e812..589669d2a93c 100644 --- a/docs/man/man1/openshift-admin-policy-add-scc-to-user.1 +++ b/docs/man/man1/openshift-admin-policy-add-scc-to-user.1 @@ -95,7 +95,7 @@ Add users or serviceaccount to a security context constraint .nf # Add the 'restricted' security context contraint to user1 and user2 openshift admin policy add\-scc\-to\-user restricted user1 user2 - + # Add the 'privileged' security context contraint to the service account serviceaccount1 in the current namespace openshift admin policy add\-scc\-to\-user privileged \-z serviceaccount1 diff --git a/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 index e820605cbe64..14d168654a67 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ openshift admin policy reconcile\-cluster\-role\-bindings \- Update cluster role Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy.Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding.This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. @@ -147,16 +145,16 @@ You can see which recommended cluster role bindings have changed by choosing an .nf # Display the names of cluster role bindings that would be modified openshift admin policy reconcile\-cluster\-role\-bindings \-o name - + # Display the cluster role bindings that would be modified, removing any extra subjects openshift admin policy reconcile\-cluster\-role\-bindings \-\-additive\-only=false - + # Update cluster role bindings that don't match the current defaults openshift admin policy reconcile\-cluster\-role\-bindings \-\-confirm - + # Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group openshift admin policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-exclude\-groups=system:authenticated - + # Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding openshift admin policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-additive\-only=false diff --git a/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 b/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 index e4d2560fdea9..d902c2e0ae51 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ openshift admin policy reconcile\-cluster\-roles \- Update cluster roles to matc Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster rolethat does not match will be replaced by the recommended bootstrap role. This command will not removeany additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. @@ -142,14 +140,14 @@ You can see which cluster roles have recommended changed by choosing an output t .nf # Display the names of cluster roles that would be modified openshift admin policy reconcile\-cluster\-roles \-o name - + # Add missing permissions to cluster roles that don't match the current defaults openshift admin policy reconcile\-cluster\-roles \-\-confirm - + # Add missing permissions and remove extra permissions from # cluster roles that don't match the current defaults openshift admin policy reconcile\-cluster\-roles \-\-additive\-only=false \-\-confirm - + # Display the union of the default and modified cluster roles openshift admin policy reconcile\-cluster\-roles \-\-additive\-only diff --git a/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 b/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 index 502ee16517af..7a602c1acc49 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ openshift admin policy reconcile\-sccs \- Replace cluster SCCs to match the reco Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs.Any cluster SCC that does not match will be replaced by the recommended SCC.This command will not remove any additional cluster SCCs. By default, this commandwill not remove additional users and groups that have been granted access to the SCC andwill preserve existing priorities (but will always reconcile unset priorities and the policydefinition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. @@ -146,11 +141,11 @@ You can see which cluster SCCs have recommended changes by choosing an output ty .nf # Display the cluster SCCs that would be modified openshift admin policy reconcile\-sccs - + # Update cluster SCCs that don't match the current defaults preserving additional grants # for users and group and keeping any priorities that are already set openshift admin policy reconcile\-sccs \-\-confirm - + # Replace existing users, groups, and priorities that do not match defaults openshift admin policy reconcile\-sccs \-\-additive\-only=false \-\-confirm diff --git a/docs/man/man1/openshift-admin-policy.1 b/docs/man/man1/openshift-admin-policy.1 index 1743df74a546..9bdd4002be85 100644 --- a/docs/man/man1/openshift-admin-policy.1 +++ b/docs/man/man1/openshift-admin-policy.1 @@ -16,13 +16,10 @@ openshift admin policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcilecommands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the followingresources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings',and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-prune-builds.1 b/docs/man/man1/openshift-admin-prune-builds.1 index 77f7e3e901b8..0afb5166a576 100644 --- a/docs/man/man1/openshift-admin-prune-builds.1 +++ b/docs/man/man1/openshift-admin-prune-builds.1 @@ -16,8 +16,7 @@ openshift admin prune builds \- Remove old completed and failed builds Prune old completed and failed builds .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -116,7 +115,7 @@ By default, the prune operation performs a dry run making no changes to internal # Dry run deleting older completed and failed builds and also including # all builds whose associated BuildConfig no longer exists openshift admin prune builds \-\-orphans - + # To actually perform the prune operation, the confirm flag must be appended openshift admin prune builds \-\-orphans \-\-confirm diff --git a/docs/man/man1/openshift-admin-prune-deployments.1 b/docs/man/man1/openshift-admin-prune-deployments.1 index bdb894086f0a..46b158e03a3e 100644 --- a/docs/man/man1/openshift-admin-prune-deployments.1 +++ b/docs/man/man1/openshift-admin-prune-deployments.1 @@ -16,8 +16,7 @@ openshift admin prune deployments \- Remove old completed and failed deployments Prune old completed and failed deployments .PP -By default, the prune operation performs a dry run making no changes to the deployments. -A \-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to the deployments.A \-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -115,7 +114,7 @@ A \-\-confirm flag is needed for changes to be effective. .nf # Dry run deleting all but the last complete deployment for every deployment config openshift admin prune deployments \-\-keep\-complete=1 - + # To actually perform the prune operation, the confirm flag must be appended openshift admin prune deployments \-\-keep\-complete=1 \-\-confirm diff --git a/docs/man/man1/openshift-admin-prune-groups.1 b/docs/man/man1/openshift-admin-prune-groups.1 index f3d8b09210a5..0da6cd48043c 100644 --- a/docs/man/man1/openshift-admin-prune-groups.1 +++ b/docs/man/man1/openshift-admin-prune-groups.1 @@ -16,13 +16,7 @@ openshift admin prune groups \- Prune OpenShift groups referencing missing recor Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups openshift admin prune groups \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file openshift admin prune groups \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file openshift admin prune groups \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist openshift admin prune groups groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-admin-prune-images.1 b/docs/man/man1/openshift-admin-prune-images.1 index 09196094dc9b..ce3890b00cdb 100644 --- a/docs/man/man1/openshift-admin-prune-images.1 +++ b/docs/man/man1/openshift-admin-prune-images.1 @@ -16,12 +16,10 @@ openshift admin prune images \- Remove unreferenced images Prune images no longer needed due to age and/or status .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .PP -Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete the -images. +Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete theimages. .SH OPTIONS @@ -120,14 +118,14 @@ images. # See, what the prune command would delete if only images more than an hour old and obsoleted # by 3 newer revisions under the same tag were considered. openshift admin prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m - + # To actually perform the prune operation, the confirm flag must be appended openshift admin prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm - + # See, what the prune command would delete if we're interested in removing images # exceeding currently set LimitRanges ('openshift.io/Image') openshift admin prune images \-\-prune\-over\-size\-limit - + # To actually perform the prune operation, the confirm flag must be appended openshift admin prune images \-\-prune\-over\-size\-limit \-\-confirm diff --git a/docs/man/man1/openshift-admin-prune.1 b/docs/man/man1/openshift-admin-prune.1 index 80c6b13267d6..b2a5323af7bc 100644 --- a/docs/man/man1/openshift-admin-prune.1 +++ b/docs/man/man1/openshift-admin-prune.1 @@ -16,8 +16,7 @@ openshift admin prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources onthe system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-registry.1 b/docs/man/man1/openshift-admin-registry.1 index dae6f5d8f4b4..ff7bce51544b 100644 --- a/docs/man/man1/openshift-admin-registry.1 +++ b/docs/man/man1/openshift-admin-registry.1 @@ -16,28 +16,16 @@ openshift admin registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications whenimages are pushed. With no arguments, the command will check for the existing registry servicecalled 'docker\-registry' and try to create it. If you want to test whether the registry hasbeen created add the \-\-dry\-run flag and the command will exit with 1 if the registry does notexist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like anobject store (several are supported by the Docker registry). The default Docker registry imageis configured to accept configuration as environment variables \- refer to the configuration file inthat image for more on setting up alternative storage. Once you've made those changes, you canpass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setupuses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will bechosen for use as the REGISTRYHTTPADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a newinstallation. Some configuration beyond this command is still required to makeyour registry persist data. .SH OPTIONS @@ -191,16 +179,16 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .nf # Check if default Docker registry ("docker\-registry") has been created openshift admin registry \-\-dry\-run - + # See what the registry will look like if created openshift admin registry \-o yaml - + # Create a registry with two replicas if it does not exist openshift admin registry \-\-replicas=2 - + # Use a different registry image openshift admin registry \-\-images=myrepo/docker\-registry:mytag - + # Enforce quota and limits on images openshift admin registry \-\-enforce\-quota diff --git a/docs/man/man1/openshift-admin-router.1 b/docs/man/man1/openshift-admin-router.1 index c89580846107..0a9f6a0dfcaf 100644 --- a/docs/man/man1/openshift-admin-router.1 +++ b/docs/man/man1/openshift-admin-router.1 @@ -16,17 +16,10 @@ openshift admin router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it toyour application. With no arguments, the command will check for an existing routerservice called 'router' and create one if it does not exist. If you want to test whethera router has already been created add the \-\-dry\-run flag and the command will exit with1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command willcreate a deployment configuration and service that will run the router. If you arerunning your router in production, you should pass \-\-replicas=2 or higher to ensureyou have failover protection. .SH OPTIONS @@ -232,19 +225,18 @@ you have failover protection. .nf # Check the default router ("router") openshift admin router \-\-dry\-run - + # See what the router would look like if created openshift admin router \-o yaml - + # Create a router with two replicas if it does not exist openshift admin router router\-west \-\-replicas=2 - + # Use a different router image openshift admin router region\-west \-\-images=myrepo/somerouter:mytag - + # Run the router with a hint to the underlying implementation to \_not\_ expose statistics. openshift admin router router\-west \-\-stats\-port=0 - .fi .RE diff --git a/docs/man/man1/openshift-admin-taint.1 b/docs/man/man1/openshift-admin-taint.1 index 1e30f7a9f652..4bd5ffcbd68f 100644 --- a/docs/man/man1/openshift-admin-taint.1 +++ b/docs/man/man1/openshift-admin-taint.1 @@ -16,11 +16,7 @@ openshift admin taint \- Update the taints on one or more nodes Update the taints on one or more nodes. .PP -A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. -The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The effect must be NoSchedule or PreferNoSchedule. -Currently taint can only apply to node. +A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The effect must be NoSchedule or PreferNoSchedule.Currently taint can only apply to node. .SH OPTIONS @@ -152,16 +148,15 @@ Currently taint can only apply to node. .RS .nf - -# Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. -# If a taint with that key and effect already exists, its value is replaced as specified. -openshift admin taint nodes foo dedicated=special\-user:NoSchedule - -# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. -openshift admin taint nodes foo dedicated:NoSchedule\- - -# Remove from node 'foo' all the taints with key 'dedicated' -openshift admin taint nodes foo dedicated\- + # Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. + # If a taint with that key and effect already exists, its value is replaced as specified. + openshift admin taint nodes foo dedicated=special\-user:NoSchedule + + # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. + openshift admin taint nodes foo dedicated:NoSchedule\- + + # Remove from node 'foo' all the taints with key 'dedicated' + openshift admin taint nodes foo dedicated\- .fi .RE diff --git a/docs/man/man1/openshift-admin-top-images.1 b/docs/man/man1/openshift-admin-top-images.1 index 31fec38d52c2..e3833d5e33ec 100644 --- a/docs/man/man1/openshift-admin-top-images.1 +++ b/docs/man/man1/openshift-admin-top-images.1 @@ -16,8 +16,7 @@ openshift admin top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-top-imagestreams.1 b/docs/man/man1/openshift-admin-top-imagestreams.1 index 981597a7b109..63ad7308cb79 100644 --- a/docs/man/man1/openshift-admin-top-imagestreams.1 +++ b/docs/man/man1/openshift-admin-top-imagestreams.1 @@ -16,8 +16,7 @@ openshift admin top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-top-node.1 b/docs/man/man1/openshift-admin-top-node.1 index e2b342703905..a6406d712a55 100644 --- a/docs/man/man1/openshift-admin-top-node.1 +++ b/docs/man/man1/openshift-admin-top-node.1 @@ -96,12 +96,11 @@ The top\-node command allows you to see the resource consumption of nodes. .RS .nf - -# Show metrics for all nodes -kubectl top node - -# Show metrics for a given node -kubectl top node NODE\_NAME + # Show metrics for all nodes + kubectl top node + + # Show metrics for a given node + kubectl top node NODE\_NAME .fi .RE diff --git a/docs/man/man1/openshift-admin-top-pod.1 b/docs/man/man1/openshift-admin-top-pod.1 index e3ee43cecbb5..cdf2168f2b59 100644 --- a/docs/man/man1/openshift-admin-top-pod.1 +++ b/docs/man/man1/openshift-admin-top-pod.1 @@ -19,8 +19,7 @@ Display Resource (CPU/Memory/Storage) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. .PP -Due to the metrics pipeline delay, they may be unavailable for a few minutes -since pod creation. +Due to the metrics pipeline delay, they may be unavailable for a few minutessince pod creation. .SH OPTIONS @@ -108,18 +107,17 @@ since pod creation. .RS .nf - -# Show metrics for all pods in the default namespace -kubectl top pod - -# Show metrics for all pods in the given namespace -kubectl top pod \-\-namespace=NAMESPACE - -# Show metrics for a given pod and its containers -kubectl top pod POD\_NAME \-\-containers - -# Show metrics for the pods defined by label name=myLabel -kubectl top pod \-l name=myLabel + # Show metrics for all pods in the default namespace + kubectl top pod + + # Show metrics for all pods in the given namespace + kubectl top pod \-\-namespace=NAMESPACE + + # Show metrics for a given pod and its containers + kubectl top pod POD\_NAME \-\-containers + + # Show metrics for the pods defined by label name=myLabel + kubectl top pod \-l name=myLabel .fi .RE diff --git a/docs/man/man1/openshift-admin-top.1 b/docs/man/man1/openshift-admin-top.1 index 00b14d0e7e34..b9356f4429fe 100644 --- a/docs/man/man1/openshift-admin-top.1 +++ b/docs/man/man1/openshift-admin-top.1 @@ -16,8 +16,7 @@ openshift admin top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-admin-uncordon.1 b/docs/man/man1/openshift-admin-uncordon.1 index a3fc75c137ed..7db6ee16905d 100644 --- a/docs/man/man1/openshift-admin-uncordon.1 +++ b/docs/man/man1/openshift-admin-uncordon.1 @@ -87,10 +87,8 @@ Mark node as schedulable. .RS .nf - -# Mark node "foo" as schedulable. -$ openshift admin uncordon foo - + # Mark node "foo" as schedulable. + $ openshift admin uncordon foo .fi .RE diff --git a/docs/man/man1/openshift-admin.1 b/docs/man/man1/openshift-admin.1 index 1e1e8c7e6b8a..5859fd35b2d8 100644 --- a/docs/man/man1/openshift-admin.1 +++ b/docs/man/man1/openshift-admin.1 @@ -16,8 +16,7 @@ openshift admin \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrativeactions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-build-chain.1 b/docs/man/man1/openshift-cli-adm-build-chain.1 index c0182cc5a918..f4ff434ff51e 100644 --- a/docs/man/man1/openshift-cli-adm-build-chain.1 +++ b/docs/man/man1/openshift-cli-adm-build-chain.1 @@ -16,9 +16,7 @@ openshift cli adm build\-chain \- Output the inputs and dependencies of your bui Output the inputs and dependencies of your builds .PP -Supported formats for the generated graph are dot and a human\-readable output. -Tag and namespace are optional and if they are not specified, 'latest' and the -default namespace will be used respectively. +Supported formats for the generated graph are dot and a human\-readable output.Tag and namespace are optional and if they are not specified, 'latest' and thedefault namespace will be used respectively. .SH OPTIONS @@ -112,10 +110,10 @@ default namespace will be used respectively. .nf # Build the dependency tree for the 'latest' tag in openshift cli adm build\-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility openshift cli adm build\-chain :v2 \-o dot | dot \-T svg \-o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace openshift cli adm build\-chain \-n test \-\-all diff --git a/docs/man/man1/openshift-cli-adm-ca-create-key-pair.1 b/docs/man/man1/openshift-cli-adm-ca-create-key-pair.1 index 6ca161e9320a..34b7edbdedde 100644 --- a/docs/man/man1/openshift-cli-adm-ca-create-key-pair.1 +++ b/docs/man/man1/openshift-cli-adm-ca-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -openshift cli adm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + openshift cli adm ca create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-ca-create-master-certs.1 b/docs/man/man1/openshift-cli-adm-ca-create-master-certs.1 index 1c13f7835365..a64d7a06003d 100644 --- a/docs/man/man1/openshift-cli-adm-ca-create-master-certs.1 +++ b/docs/man/man1/openshift-cli-adm-ca-create-master-certs.1 @@ -16,66 +16,39 @@ openshift cli adm ca create\-master\-certs \- Create certificates and keys for a Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -openshift cli adm ca create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + openshift cli adm ca create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-ca-create-server-cert.1 b/docs/man/man1/openshift-cli-adm-ca-create-server-cert.1 index 351bf05177b3..4d6b7714a069 100644 --- a/docs/man/man1/openshift-cli-adm-ca-create-server-cert.1 +++ b/docs/man/man1/openshift-cli-adm-ca-create-server-cert.1 @@ -16,26 +16,18 @@ openshift cli adm ca create\-server\-cert \- Create a signed server certificate Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -openshift cli adm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + openshift cli adm ca create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-ca-decrypt.1 b/docs/man/man1/openshift-cli-adm-ca-decrypt.1 index bce23d1286aa..ce304d20b186 100644 --- a/docs/man/man1/openshift-cli-adm-ca-decrypt.1 +++ b/docs/man/man1/openshift-cli-adm-ca-decrypt.1 @@ -101,12 +101,11 @@ Decrypt data encrypted with "openshift cli adm ca encrypt" .RS .nf - # Decrypt an encrypted file to a cleartext file: - openshift cli adm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted - - # Decrypt from stdin to stdout: - openshift cli adm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted - + # Decrypt an encrypted file to a cleartext file: + openshift cli adm ca decrypt \-\-key=secret.key \-\-in=secret.encrypted \-\-out=secret.decrypted + + # Decrypt from stdin to stdout: + openshift cli adm ca decrypt \-\-key=secret.key < secret2.encrypted > secret2.decrypted .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-ca-encrypt.1 b/docs/man/man1/openshift-cli-adm-ca-encrypt.1 index d844bb979a1e..cef0c99458e6 100644 --- a/docs/man/man1/openshift-cli-adm-ca-encrypt.1 +++ b/docs/man/man1/openshift-cli-adm-ca-encrypt.1 @@ -105,12 +105,11 @@ Encrypt data with AES\-256\-CBC encryption .RS .nf - # Encrypt the content of secret.txt with a generated key: - openshift cli adm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted - - # Encrypt the content of secret2.txt with an existing key: - openshift cli adm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted - + # Encrypt the content of secret.txt with a generated key: + openshift cli adm ca encrypt \-\-genkey=secret.key \-\-in=secret.txt \-\-out=secret.encrypted + + # Encrypt the content of secret2.txt with an existing key: + openshift cli adm ca encrypt \-\-key=secret.key < secret2.txt > secret2.encrypted .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-completion.1 b/docs/man/man1/openshift-cli-adm-completion.1 index 4e9d5ba0a94a..9a17e7a82254 100644 --- a/docs/man/man1/openshift-cli-adm-completion.1 +++ b/docs/man/man1/openshift-cli-adm-completion.1 @@ -13,8 +13,7 @@ openshift cli adm completion \- Output shell completion code for the given shell .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift cli adm commands. +This command prints shell code which must be evaluated to provide interactivecompletion of openshift cli adm commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -91,18 +90,19 @@ completion of openshift cli adm commands. # Generate the openshift cli adm completion code for bash openshift cli adm completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion openshift cli adm completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(openshift cli adm completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/openshift-cli-adm-config-current-context.1 b/docs/man/man1/openshift-cli-adm-config-current-context.1 index d1bbc49db29d..1016808a2553 100644 --- a/docs/man/man1/openshift-cli-adm-config-current-context.1 +++ b/docs/man/man1/openshift-cli-adm-config-current-context.1 @@ -87,7 +87,6 @@ Displays the current\-context .RS .nf - # Display the current\-context openshift cli adm config current\-context diff --git a/docs/man/man1/openshift-cli-adm-config-set-cluster.1 b/docs/man/man1/openshift-cli-adm-config-set-cluster.1 index f578e60cc680..99f5ad44c13a 100644 --- a/docs/man/man1/openshift-cli-adm-config-set-cluster.1 +++ b/docs/man/man1/openshift-cli-adm-config-set-cluster.1 @@ -13,8 +13,7 @@ openshift cli adm config set\-cluster \- Sets a cluster entry in kubeconfig .SH DESCRIPTION .PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set only the server field on the e2e cluster entry without touching other values. openshift cli adm config set\-cluster e2e \-\-server=https://1.2.3.4 diff --git a/docs/man/man1/openshift-cli-adm-config-set-context.1 b/docs/man/man1/openshift-cli-adm-config-set-context.1 index b46717e514e6..737f87b16ae8 100644 --- a/docs/man/man1/openshift-cli-adm-config-set-context.1 +++ b/docs/man/man1/openshift-cli-adm-config-set-context.1 @@ -13,8 +13,7 @@ openshift cli adm config set\-context \- Sets a context entry in kubeconfig .SH DESCRIPTION .PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set the user field on the gce context entry without touching other values openshift cli adm config set\-context gce \-\-user=cluster\-admin diff --git a/docs/man/man1/openshift-cli-adm-config-set-credentials.1 b/docs/man/man1/openshift-cli-adm-config-set-credentials.1 index 430dee8b6e4c..c9ecb23c25c1 100644 --- a/docs/man/man1/openshift-cli-adm-config-set-credentials.1 +++ b/docs/man/man1/openshift-cli-adm-config-set-credentials.1 @@ -13,20 +13,16 @@ openshift cli adm config set\-credentials \- Sets a user entry in kubeconfig .SH DESCRIPTION .PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. +Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values. .PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile +Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile .PP -Bearer token flags: - \-\-token=bearer\_token +Bearer token flags:\-\-token=bearer\_token .PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password +Basic auth flags:\-\-username=basicuser \-\-password=basicpassword .PP Bearer token and basic auth are mutually exclusive. @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive. .RS .nf - # Set only the "client\-key" field on the "cluster\-admin" # entry, without touching other values: openshift cli adm config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key diff --git a/docs/man/man1/openshift-cli-adm-config-set.1 b/docs/man/man1/openshift-cli-adm-config-set.1 index 69fd48579835..96ab6855b4bb 100644 --- a/docs/man/man1/openshift-cli-adm-config-set.1 +++ b/docs/man/man1/openshift-cli-adm-config-set.1 @@ -13,9 +13,7 @@ openshift cli adm config set \- Sets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. +Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-config-unset.1 b/docs/man/man1/openshift-cli-adm-config-unset.1 index 842316a49878..fbbfd5c80b3b 100644 --- a/docs/man/man1/openshift-cli-adm-config-unset.1 +++ b/docs/man/man1/openshift-cli-adm-config-unset.1 @@ -13,8 +13,7 @@ openshift cli adm config unset \- Unsets an individual value in a kubeconfig fil .SH DESCRIPTION .PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. +Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-config-view.1 b/docs/man/man1/openshift-cli-adm-config-view.1 index 6f4507c0d0d5..5cbcc73818bc 100644 --- a/docs/man/man1/openshift-cli-adm-config-view.1 +++ b/docs/man/man1/openshift-cli-adm-config-view.1 @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat .RS .nf - # Show Merged kubeconfig settings. openshift cli adm config view diff --git a/docs/man/man1/openshift-cli-adm-config.1 b/docs/man/man1/openshift-cli-adm-config.1 index 8bc2109379c4..8c987584d5d5 100644 --- a/docs/man/man1/openshift-cli-adm-config.1 +++ b/docs/man/man1/openshift-cli-adm-config.1 @@ -16,9 +16,7 @@ openshift cli adm config \- Change configuration files for the client Manage the client config files .PP -The client stores configuration in the current user's home directory (under the .kube directory as -config). When you login the first time, a new config file is created, and subsequent project changes with the -'project' command will set the current context. These subcommands allow you to manage the config directly. +The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly. .PP Reference: diff --git a/docs/man/man1/openshift-cli-adm-cordon.1 b/docs/man/man1/openshift-cli-adm-cordon.1 index 95eb6ea2d5dc..140ade651e64 100644 --- a/docs/man/man1/openshift-cli-adm-cordon.1 +++ b/docs/man/man1/openshift-cli-adm-cordon.1 @@ -87,10 +87,8 @@ Mark node as unschedulable. .RS .nf - -# Mark node "foo" as unschedulable. -openshift cli adm cordon foo - + # Mark node "foo" as unschedulable. + openshift cli adm cordon foo .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-create-api-client-config.1 b/docs/man/man1/openshift-cli-adm-create-api-client-config.1 index eac6ef879758..65a3f34477ca 100644 --- a/docs/man/man1/openshift-cli-adm-create-api-client-config.1 +++ b/docs/man/man1/openshift-cli-adm-create-api-client-config.1 @@ -16,9 +16,7 @@ openshift cli adm create\-api\-client\-config \- Create a config file for connec Create a client configuration for connecting to the server .PP -This command creates a folder containing a client certificate, a client key, -a server certificate authority, and a .kubeconfig file for connecting to the -master as the provided user. +This command creates a folder containing a client certificate, a client key,a server certificate authority, and a .kubeconfig file for connecting to themaster as the provided user. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-create-error-template.1 b/docs/man/man1/openshift-cli-adm-create-error-template.1 index 881e6a0c91e5..15790891eba1 100644 --- a/docs/man/man1/openshift-cli-adm-create-error-template.1 +++ b/docs/man/man1/openshift-cli-adm-create-error-template.1 @@ -16,24 +16,15 @@ openshift cli adm create\-error\-template \- Create an error page template Create a template for customizing the error page .PP -This command creates a basic template to use as a starting point for -customizing the authentication error page. Save the output to a file and edit -the template to change the look and feel or add content. +This command creates a basic template to use as a starting point forcustomizing the authentication error page. Save the output to a file and editthe template to change the look and feel or add content. .PP -To use the template, set oauthConfig.templates.error in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.error in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - error: templates/error.html - -.fi -.RE + templates: + error: templates/error.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-create-key-pair.1 b/docs/man/man1/openshift-cli-adm-create-key-pair.1 index 0b56d55f391a..cfa0c41ce206 100644 --- a/docs/man/man1/openshift-cli-adm-create-key-pair.1 +++ b/docs/man/man1/openshift-cli-adm-create-key-pair.1 @@ -19,14 +19,8 @@ Create an RSA key pair and generate PEM\-encoded public/private key files Example: Creating service account signing and authenticating key files: .PP -.RS - -.nf CONFIG=openshift.local.config/master -openshift cli adm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key - -.fi -.RE + openshift cli adm create\-key\-pair \-\-public\-key=$CONFIG/serviceaccounts.public.key \-\-private\-key=$CONFIG/serviceaccounts.private.key .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-create-kubeconfig.1 b/docs/man/man1/openshift-cli-adm-create-kubeconfig.1 index 4430e15cf0a4..ee4d816b8e36 100644 --- a/docs/man/man1/openshift-cli-adm-create-kubeconfig.1 +++ b/docs/man/man1/openshift-cli-adm-create-kubeconfig.1 @@ -13,36 +13,36 @@ openshift cli adm create\-kubeconfig \- Create a basic .kubeconfig file from cli .SH DESCRIPTION .PP -Create's a .kubeconfig file at <\-\-kubeconfig> that looks like this: +Create's a .kubeconfig file at<\-\-kubeconfig> that looks like this: .PP clusters: -\- cluster: - certificate\-authority\-data: - server: <\-\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-master> name: <\-\-cluster> -\- cluster: - certificate\-authority\-data: - server: <\-\-public\-master> + \- cluster: + certificate\-authority\-data: + server: <\-\-public\-master> name: public\-<\-\-cluster> -contexts: -\- context: - cluster: <\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + contexts: + \- context: + cluster: <\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: <\-\-context> -\- context: - cluster: public\-<\-\-cluster> - user: <\-\-user> - namespace: <\-\-namespace> + \- context: + cluster: public\-<\-\-cluster> + user: <\-\-user> + namespace: <\-\-namespace> name: public\-<\-\-context> -current\-context: <\-\-context> -kind: Config -users: -\- name: <\-\-user> + current\-context: <\-\-context> + kind: Config + users: + \- name: <\-\-user> user: - client\-certificate\-data: - client\-key\-data: + client\-certificate\-data: + client\-key\-data: .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-create-login-template.1 b/docs/man/man1/openshift-cli-adm-create-login-template.1 index 62ca3bcb06dc..a806f84eba8d 100644 --- a/docs/man/man1/openshift-cli-adm-create-login-template.1 +++ b/docs/man/man1/openshift-cli-adm-create-login-template.1 @@ -16,25 +16,15 @@ openshift cli adm create\-login\-template \- Create a login template Create a template for customizing the login page .PP -This command creates a basic template to use as a starting point for -customizing the login page. Save the output to a file and edit the template to -change the look and feel or add content. Be careful not to remove any parameter -values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login page. Save the output to a file and edit the template tochange the look and feel or add content. Be careful not to remove any parametervalues inside curly braces. .PP -To use the template, set oauthConfig.templates.login in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.login in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - login: templates/login.html - -.fi -.RE + templates: + login: templates/login.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-create-master-certs.1 b/docs/man/man1/openshift-cli-adm-create-master-certs.1 index eed291a8a8ab..8bbcc6dc3820 100644 --- a/docs/man/man1/openshift-cli-adm-create-master-certs.1 +++ b/docs/man/man1/openshift-cli-adm-create-master-certs.1 @@ -16,66 +16,39 @@ openshift cli adm create\-master\-certs \- Create keys and certificates for a master .PP -This command creates keys and certs necessary to run a secure master. -It also creates keys, certificates, and configuration necessary for most -related infrastructure components that are clients to the master. -See the related "create\-node\-config" command for generating per\-node config. +This command creates keys and certs necessary to run a secure master.It also creates keys, certificates, and configuration necessary for mostrelated infrastructure components that are clients to the master.See the related "create\-node\-config" command for generating per\-node config. .PP All files are expected or created in standard locations under the cert\-dir. .PP -.RS - -.nf openshift.local.config/master/ - ca.{crt,key,serial.txt} - master.server.{crt,key} - openshift\-router.{crt,key,kubeconfig} - admin.{crt,key,kubeconfig} - ... - -.fi -.RE + ca.{crt,key,serial.txt} + master.server.{crt,key} + openshift\-router.{crt,key,kubeconfig} + admin.{crt,key,kubeconfig} + ... .PP -Note that the certificate authority (CA aka "signer") generated automatically -is self\-signed. In production usage, administrators are more likely to -want to generate signed certificates separately rather than rely on a -generated CA. Alternatively, start with an existing signed CA and -have this command use it to generate valid certificates. +Note that the certificate authority (CA aka "signer") generated automaticallyis self\-signed. In production usage, administrators are more likely towant to generate signed certificates separately rather than rely on agenerated CA. Alternatively, start with an existing signed CA andhave this command use it to generate valid certificates. .PP -This command would usually only be used once at installation. If you -need to regenerate the master server cert, DO NOT use \-\-overwrite as this -would recreate ALL certs including the CA cert, invalidating any existing -infrastructure or client configuration. Instead, delete/rename the existing -server cert and run the command to fill it in: +This command would usually only be used once at installation. If youneed to regenerate the master server cert, DO NOT use \-\-overwrite as thiswould recreate ALL certs including the CA cert, invalidating any existinginfrastructure or client configuration. Instead, delete/rename the existingserver cert and run the command to fill it in: .PP -.RS - -.nf mv openshift.local.config/master/master.server.crt{,.old} -openshift cli adm create\-master\-certs \-\-cert\-dir=... \\ - \-\-master=https://internal.master.fqdn:8443 \\ - \-\-public\-master=https://external.master.fqdn:8443 \\ - \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local - -.fi -.RE + openshift cli adm create\-master\-certs \-\-cert\-dir=... \\ + \-\-master= +\[la]https://internal.master.fqdn:8443\[ra] \\ + \-\-public\-master= +\[la]https://external.master.fqdn:8443\[ra] \\ + \-\-hostnames=external.master.fqdn,internal.master.fqdn,localhost,127.0.0.1,172.17.42.1,kubernetes.default.local .PP -Alternatively, use the related "ca create\-server\-cert" command to explicitly -create a certificate. +Alternatively, use the related "ca create\-server\-cert" command to explicitlycreate a certificate. .PP -Regardless of \-\-overwrite, the master server key/cert will be updated -if \-\-hostnames does not match the current certificate. -Regardless of \-\-overwrite, .kubeconfig files will be updated every time this -command is run, so always specify \-\-master (and if needed, \-\-public\-master). -This is designed to match the behavior of "start" which rewrites certs/confs -for certain configuration changes. +Regardless of \-\-overwrite, the master server key/cert will be updatedif \-\-hostnames does not match the current certificate.Regardless of \-\-overwrite, .kubeconfig files will be updated every time thiscommand is run, so always specify \-\-master (and if needed, \-\-public\-master).This is designed to match the behavior of "start" which rewrites certs/confsfor certain configuration changes. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-create-provider-selection-template.1 b/docs/man/man1/openshift-cli-adm-create-provider-selection-template.1 index 803c8d5c58dc..aaa6a3d7145b 100644 --- a/docs/man/man1/openshift-cli-adm-create-provider-selection-template.1 +++ b/docs/man/man1/openshift-cli-adm-create-provider-selection-template.1 @@ -16,25 +16,15 @@ openshift cli adm create\-provider\-selection\-template \- Create a provider sel Create a template for customizing the provider selection page .PP -This command creates a basic template to use as a starting point for -customizing the login provider selection page. Save the output to a file and edit -the template to change the look and feel or add content. Be careful not to remove -any parameter values inside curly braces. +This command creates a basic template to use as a starting point forcustomizing the login provider selection page. Save the output to a file and editthe template to change the look and feel or add content. Be careful not to removeany parameter values inside curly braces. .PP -To use the template, set oauthConfig.templates.providerSelection in the master -configuration to point to the template file. For example, +To use the template, set oauthConfig.templates.providerSelection in the masterconfiguration to point to the template file. For example, .PP -.RS - -.nf oauthConfig: - templates: - providerSelection: templates/provider\-selection.html - -.fi -.RE + templates: + providerSelection: templates/provider\-selection.html .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-create-server-cert.1 b/docs/man/man1/openshift-cli-adm-create-server-cert.1 index 8d55a73ea5c3..b5062498f867 100644 --- a/docs/man/man1/openshift-cli-adm-create-server-cert.1 +++ b/docs/man/man1/openshift-cli-adm-create-server-cert.1 @@ -16,26 +16,18 @@ openshift cli adm create\-server\-cert \- Create a key and server certificate .PP -Create a key and server certificate valid for the specified hostnames, -signed by the specified CA. These are useful for securing infrastructure -components such as the router, authentication server, etc. +Create a key and server certificate valid for the specified hostnames,signed by the specified CA. These are useful for securing infrastructurecomponents such as the router, authentication server, etc. .PP Example: Creating a secure router certificate. .PP -.RS - -.nf CA=openshift.local.config/master -openshift cli adm create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ - \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ - \-\-hostnames='*.cloudapps.example.com' \\ - \-\-cert=cloudapps.crt \-\-key=cloudapps.key -cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem - -.fi -.RE + openshift cli adm create\-server\-cert \-\-signer\-cert=$CA/ca.crt \\ + \-\-signer\-key=$CA/ca.key \-\-signer\-serial=$CA/ca.serial.txt \\ + \-\-hostnames='*.cloudapps.example.com' \\ + \-\-cert=cloudapps.crt \-\-key=cloudapps.key + cat cloudapps.crt cloudapps.key $CA/ca.crt > cloudapps.router.pem .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-diagnostics.1 b/docs/man/man1/openshift-cli-adm-diagnostics.1 index 30a71cd3dbcb..fee2532aab74 100644 --- a/docs/man/man1/openshift-cli-adm-diagnostics.1 +++ b/docs/man/man1/openshift-cli-adm-diagnostics.1 @@ -13,59 +13,32 @@ openshift cli adm diagnostics \- Diagnose common cluster problems .SH DESCRIPTION .PP -This utility helps troubleshoot and diagnose known problems. It runs -diagnostics using a client and/or the state of a running master / -node host. +This utility helps troubleshoot and diagnose known problems. It runsdiagnostics using a client and/or the state of a running master /node host. .PP -.RS - -.nf openshift cli adm diagnostics -.fi -.RE - .PP -If run without flags, it will check for standard config files for -client, master, and node, and if found, use them for diagnostics. -You may also specify config files explicitly with flags, in which case -you will receive an error if they are not found. For example: +If run without flags, it will check for standard config files forclient, master, and node, and if found, use them for diagnostics.You may also specify config files explicitly with flags, in which caseyou will receive an error if they are not found. For example: .PP -.RS - -.nf openshift cli adm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml - -.fi -.RE .IP .IP -\(bu If master/node config files are not found and the \-\-host flag is not -present, host diagnostics are skipped. +\(bu If master/node config files are not found and the \-\-host flag is notpresent, host diagnostics are skipped. .IP -\(bu If the client has cluster\-admin access, this access enables cluster -diagnostics to run which regular users cannot. +\(bu If the client has cluster\-admin access, this access enables clusterdiagnostics to run which regular users cannot. .IP -\(bu If a client config file is not found, client and cluster diagnostics -are skipped. +\(bu If a client config file is not found, client and cluster diagnosticsare skipped. .PP Diagnostics may be individually run by passing diagnostic name as arguments. .PP -.RS - -.nf openshift cli adm diagnostics -.fi -.RE - .PP -The available diagnostic names are: -AggregatedLogging AnalyzeLogs ClusterRegistry ClusterRoleBindings ClusterRoles ClusterRouter ConfigContexts DiagnosticPod MasterConfigCheck MasterNode MetricsApiProxy NodeConfigCheck NodeDefinitions ServiceExternalIPs UnitStatus +The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegistry, ClusterRoleBindings, ClusterRoles, ClusterRouter, ConfigContexts, DiagnosticPod, MasterConfigCheck, MasterNode, MetricsApiProxy, NodeConfigCheck, NodeDefinitions, ServiceExternalIPs, UnitStatus. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-drain.1 b/docs/man/man1/openshift-cli-adm-drain.1 index cd9fe86c7b69..69c56fffbba2 100644 --- a/docs/man/man1/openshift-cli-adm-drain.1 +++ b/docs/man/man1/openshift-cli-adm-drain.1 @@ -16,22 +16,14 @@ openshift cli adm drain \- Drain node in preparation for maintenance Drain node in preparation for maintenance. .PP -The given node will be marked unschedulable to prevent new pods from arriving. -Then drain deletes all pods except mirror pods (which cannot be deleted through -the API server). If there are DaemonSet\-managed pods, drain will not proceed -without \-\-ignore\-daemonsets, and regardless it will not delete any -DaemonSet\-managed pods, because those pods would be immediately replaced by the -DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed\-\-by ReplicationController, -ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless you -use \-\-force. +The given node will be marked unschedulable to prevent new pods from arriving.Then drain deletes all pods except mirror pods (which cannot be deleted throughthe API server). If there are DaemonSet\-managed pods, drain will not proceedwithout \-\-ignore\-daemonsets, and regardless it will not delete anyDaemonSet\-managed pods, because those pods would be immediately replaced by theDaemonSet controller, which ignores unschedulable markings. If there are anypods that are neither mirror pods nor managed\-\-by ReplicationController,ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless youuse \-\-force. .PP -When you are ready to put the node back into service, use kubectl uncordon, which -will make the node schedulable again. +When you are ready to put the node back into service, use kubectl uncordon, whichwill make the node schedulable again. .PP +\[la]http://kubernetes.io/images/docs/kubectl_drain.svg\[ra] .SH OPTIONS @@ -123,13 +115,11 @@ will make the node schedulable again. .RS .nf - -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ openshift cli adm drain foo \-\-force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ openshift cli adm drain foo \-\-grace\-period=900 - + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. + $ openshift cli adm drain foo \-\-force + + # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. + $ openshift cli adm drain foo \-\-grace\-period=900 .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-groups-new.1 b/docs/man/man1/openshift-cli-adm-groups-new.1 index 0d7e071a6c5f..f9789723dff6 100644 --- a/docs/man/man1/openshift-cli-adm-groups-new.1 +++ b/docs/man/man1/openshift-cli-adm-groups-new.1 @@ -126,10 +126,10 @@ This command will create a new group with an optional list of users. .nf # Add a group with no users openshift cli adm groups new my\-group - + # Add a group with two users openshift cli adm groups new my\-group user1 user2 - + # Add a group with one user and shorter output openshift cli adm groups new my\-group user1 \-o name diff --git a/docs/man/man1/openshift-cli-adm-groups-prune.1 b/docs/man/man1/openshift-cli-adm-groups-prune.1 index c0d1f2e96f60..06ba6d0b1123 100644 --- a/docs/man/man1/openshift-cli-adm-groups-prune.1 +++ b/docs/man/man1/openshift-cli-adm-groups-prune.1 @@ -16,13 +16,7 @@ openshift cli adm groups prune \- Prune OpenShift groups referencing missing rec Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups openshift cli adm groups prune \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file openshift cli adm groups prune \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file openshift cli adm groups prune \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist openshift cli adm groups prune groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-groups-sync.1 b/docs/man/man1/openshift-cli-adm-groups-sync.1 index 30c80194b7d1..b63c029b34c8 100644 --- a/docs/man/man1/openshift-cli-adm-groups-sync.1 +++ b/docs/man/man1/openshift-cli-adm-groups-sync.1 @@ -16,13 +16,7 @@ openshift cli adm groups sync \- Sync OpenShift groups with records from an exte Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wishto sync and where their records live. For instance, all or some groups may be selected from the current Groupsstored in OpenShift that have been synced previously, or similarly all or some groups may be selected from thosestored on an LDAP server. The path to a sync configuration file is required in order to describe how data isrequested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-runwithout changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by theLDAP query templates. .SH OPTIONS @@ -152,20 +146,19 @@ LDAP query templates. .nf # Sync all groups from an LDAP server openshift cli adm groups sync \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server openshift cli adm groups sync \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific groups specified in a whitelist file with an LDAP server openshift cli adm groups sync \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server openshift cli adm groups sync \-\-type=openshift \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server openshift cli adm groups sync groups/group1 groups/group2 groups/group3 \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-ipfailover.1 b/docs/man/man1/openshift-cli-adm-ipfailover.1 index 6bd7a6428c77..1bba99f9cab5 100644 --- a/docs/man/man1/openshift-cli-adm-ipfailover.1 +++ b/docs/man/man1/openshift-cli-adm-ipfailover.1 @@ -16,17 +16,10 @@ openshift cli adm ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for thecluster. An administrator can configure IP failover on an entirecluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name,the \-\-create flag can be passed to create a deployment configuration thatwill provide IP failover capability. If you are running in production, it isrecommended that the labeled selector for the nodes matches at least 2 nodesto ensure you have failover protection, and that you provide a \-\-replicas=value that matches the number of nodes for the given labeled selector. .SH OPTIONS @@ -164,18 +157,18 @@ value that matches the number of nodes for the given labeled selector. .nf # Check the default IP failover configuration ("ipfailover"): openshift cli adm ipfailover - + # See what the IP failover configuration would look like if it is created: openshift cli adm ipfailover \-o json - + # Create an IP failover configuration if it does not already exist: openshift cli adm ipfailover ipf \-\-virtual\-ips="10.1.1.1\-4" \-\-create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us\-west\-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). openshift cli adm ipfailover ipfailover \-\-selector="router=us\-west\-ha" \-\-virtual\-ips="1.2.3.4,10.1.1.100\-104,5.6.7.8" \-\-watch\-port=80 \-\-replicas=4 \-\-create - + # Use a different IP failover config image and see the configuration: openshift cli adm ipfailover ipf\-alt \-\-selector="hagroup=us\-west\-ha" \-\-virtual\-ips="1.2.3.4" \-o yaml \-\-images=myrepo/myipfailover:mytag diff --git a/docs/man/man1/openshift-cli-adm-manage-node.1 b/docs/man/man1/openshift-cli-adm-manage-node.1 index d25a1c40127c..07a91f6d9c46 100644 --- a/docs/man/man1/openshift-cli-adm-manage-node.1 +++ b/docs/man/man1/openshift-cli-adm-manage-node.1 @@ -19,8 +19,7 @@ Manage nodes This command provides common operations on nodes for administrators. .PP -schedulable: Marking node schedulable will allow pods to be schedulable on the node and - marking node unschedulable will block pods to be scheduled on the node. +schedulable: Marking node schedulable will allow pods to be schedulable on the node andmarking node unschedulable will block pods to be scheduled on the node. .PP evacuate: Migrate all/selected pod on the provided nodes. @@ -166,26 +165,26 @@ list\-pods: List all/selected pods on given/selected nodes. It can list the outp .RS .nf - # Block accepting any pods on given nodes - openshift cli adm manage\-node \-\-schedulable=false - - # Mark selected nodes as schedulable - openshift cli adm manage\-node \-\-selector="" \-\-schedulable=true - - # Migrate selected pods - openshift cli adm manage\-node \-\-evacuate \-\-pod\-selector="" - - # Migrate selected pods, use a grace period of 60 seconds - openshift cli adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" - - # Migrate selected pods not backed by replication controller - openshift cli adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" - - # Show pods that will be migrated - openshift cli adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" - - # List all pods on given nodes - openshift cli adm manage\-node \-\-list\-pods + # Block accepting any pods on given nodes + openshift cli adm manage\-node \-\-schedulable=false + + # Mark selected nodes as schedulable + openshift cli adm manage\-node \-\-selector="" \-\-schedulable=true + + # Migrate selected pods + openshift cli adm manage\-node \-\-evacuate \-\-pod\-selector="" + + # Migrate selected pods, use a grace period of 60 seconds + openshift cli adm manage\-node \-\-evacuate \-\-grace\-period=60 \-\-pod\-selector="" + + # Migrate selected pods not backed by replication controller + openshift cli adm manage\-node \-\-evacuate \-\-force \-\-pod\-selector="" + + # Show pods that will be migrated + openshift cli adm manage\-node \-\-evacuate \-\-dry\-run \-\-pod\-selector="" + + # List all pods on given nodes + openshift cli adm manage\-node \-\-list\-pods .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-migrate-image-references.1 b/docs/man/man1/openshift-cli-adm-migrate-image-references.1 index ef73c2788783..04606372e201 100644 --- a/docs/man/man1/openshift-cli-adm-migrate-image-references.1 +++ b/docs/man/man1/openshift-cli-adm-migrate-image-references.1 @@ -16,34 +16,35 @@ openshift cli adm migrate image\-references \- Update embedded Docker image refe Migrate references to Docker images .PP -This command updates embedded Docker image references on the server in place. By default it -will update image streams and images, and may be used to update resources with a pod template -(deployments, replication controllers, daemon sets). +This command updates embedded Docker image references on the server in place. By default itwill update image streams and images, and may be used to update resources with a pod template(deployments, replication controllers, daemon sets). .PP -References are changed by providing a mapping between a source registry and name and the -desired registry and name. Either name or registry can be set to '*' to change all values. -The registry value "docker.io" is special and will handle any image reference that refers to -the DockerHub. You may pass multiple mappings \- the first matching mapping will be applied -per resource. +References are changed by providing a mapping between a source registry and name and thedesired registry and name. Either name or registry can be set to '*' to change all values.The registry value "docker.io" is special and will handle any image reference that refers tothe DockerHub. You may pass multiple mappings \- the first matching mapping will be appliedper resource. .PP The following resource types may be migrated by this command: .IP .IP -\(bu images * daemonsets +\(bu buildconfigs .IP -\(bu imagestreams * jobs +\(bu daemonsets .IP -\(bu buildconfigs * replicationcontrollers +\(bu deploymentconfigs .IP -\(bu deploymentconfigs * pods +\(bu images +.IP +\(bu imagestreams +.IP +\(bu jobs +.IP +\(bu pods +.IP +\(bu replicationcontrollers .IP \(bu secrets (docker) .PP -Only images, imagestreams, and secrets are updated by default. Updating images and image -streams requires administrative privileges. +Only images, imagestreams, and secrets are updated by default. Updating images and imagestreams requires administrative privileges. .SH OPTIONS @@ -149,16 +150,16 @@ streams requires administrative privileges. .nf # Perform a dry\-run of migrating all "docker.io" references to "myregistry.com" openshift cli adm migrate image\-references docker.io/*=myregistry.com/* - + # To actually perform the migration, the confirm flag must be appended openshift cli adm migrate image\-references docker.io/*=myregistry.com/* \-\-confirm - + # To see more details of what will be migrated, use the loglevel and output flags openshift cli adm migrate image\-references docker.io/*=myregistry.com/* \-\-loglevel=2 \-o yaml - + # Migrate from a service IP to an internal service DNS name openshift cli adm migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* - + # Migrate from a service IP to an internal service DNS name for all deployment configs and builds openshift cli adm migrate image\-references 172.30.1.54/*=registry.openshift.svc.cluster.local/* \-\-include=buildconfigs,deploymentconfigs diff --git a/docs/man/man1/openshift-cli-adm-migrate-storage.1 b/docs/man/man1/openshift-cli-adm-migrate-storage.1 index c387b449cda5..52825cc0f523 100644 --- a/docs/man/man1/openshift-cli-adm-migrate-storage.1 +++ b/docs/man/man1/openshift-cli-adm-migrate-storage.1 @@ -16,25 +16,16 @@ openshift cli adm migrate storage \- Update the stored version of API objects Migrate internal object storage via update .PP -This command invokes an update operation on every API object reachable by the caller. This forces -the server to write to the underlying storage if the object representation has changed. Use this -command to ensure that the most recent storage changes have been applied to all objects (storage -version, storage encoding, any newer object defaults). +This command invokes an update operation on every API object reachable by the caller. This forcesthe server to write to the underlying storage if the object representation has changed. Use thiscommand to ensure that the most recent storage changes have been applied to all objects (storageversion, storage encoding, any newer object defaults). .PP -To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a run -the command will output a list of resources that received errors, which you can then re\-run the -command on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource names -to operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scoped -resources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. +To operate on a subset of resources, use the \-\-include flag. If you encounter errors during a runthe command will output a list of resources that received errors, which you can then re\-run thecommand on. You may also specify \-\-from\-key and \-\-to\-key to restrict the set of resource namesto operate on (key is NAMESPACE/NAME for resources in namespaces or NAME for cluster scopedresources). \-\-from\-key is inclusive if specified, while \-\-to\-key is exclusive. .PP -By default, events are not migrated since they expire within a very short period of time. If you -have significantly increased the expiration time of events, run a migration with \-\-include=events +By default, events are not migrated since they expire within a very short period of time. If youhave significantly increased the expiration time of events, run a migration with \-\-include=events .PP -WARNING: This is a slow command and will put significant load on an API server. It may also - result in significant intra\-cluster traffic. +WARNING: This is a slow command and will put significant load on an API server. It may alsoresult in significant intra\-cluster traffic. .SH OPTIONS @@ -140,17 +131,16 @@ WARNING: This is a slow command and will put significant load on an API server. .nf # Perform a dry\-run of updating all objects openshift cli adm migrate storage - + # To actually perform the update, the confirm flag must be appended openshift cli adm migrate storage \-\-confirm - + # Only migrate pods openshift cli adm migrate storage \-\-include=pods \-\-confirm - + # Only pods that are in namespaces starting with "bar" openshift cli adm migrate storage \-\-include=pods \-\-confirm \-\-from\-key=bar/ \-\-to\-key=bar/\\xFF - .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-new-project.1 b/docs/man/man1/openshift-cli-adm-new-project.1 index 08b13a793393..c1f27607586d 100644 --- a/docs/man/man1/openshift-cli-adm-new-project.1 +++ b/docs/man/man1/openshift-cli-adm-new-project.1 @@ -16,9 +16,7 @@ openshift cli adm new\-project \- Create a new project Create a new project .PP -Use this command to create a project. You may optionally specify metadata about the project, -an admin user (and role, if you want to use a non\-default admin role), and a node selector -to restrict which nodes pods in this project can be scheduled to. +Use this command to create a project. You may optionally specify metadata about the project,an admin user (and role, if you want to use a non\-default admin role), and a node selectorto restrict which nodes pods in this project can be scheduled to. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-adm-pod-network-isolate-projects.1 b/docs/man/man1/openshift-cli-adm-pod-network-isolate-projects.1 index c5a927d01cf3..516caed348fd 100644 --- a/docs/man/man1/openshift-cli-adm-pod-network-isolate-projects.1 +++ b/docs/man/man1/openshift-cli-adm-pod-network-isolate-projects.1 @@ -96,11 +96,11 @@ Allows projects to isolate their network from other projects when using the redh .RS .nf - # Provide isolation for project p1 - openshift cli adm pod\-network isolate\-projects - - # Allow all projects with label name=top\-secret to have their own isolated project network - openshift cli adm pod\-network isolate\-projects \-\-selector='name=top\-secret' + # Provide isolation for project p1 + openshift cli adm pod\-network isolate\-projects + + # Allow all projects with label name=top\-secret to have their own isolated project network + openshift cli adm pod\-network isolate\-projects \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-pod-network-join-projects.1 b/docs/man/man1/openshift-cli-adm-pod-network-join-projects.1 index ae0a22a7c1ca..41f5e8fd04c4 100644 --- a/docs/man/man1/openshift-cli-adm-pod-network-join-projects.1 +++ b/docs/man/man1/openshift-cli-adm-pod-network-join-projects.1 @@ -100,11 +100,11 @@ Allows projects to join existing project network when using the redhat/openshift .RS .nf - # Allow project p2 to use project p1 network - openshift cli adm pod\-network join\-projects \-\-to= - - # Allow all projects with label name=top\-secret to use project p1 network - openshift cli adm pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' + # Allow project p2 to use project p1 network + openshift cli adm pod\-network join\-projects \-\-to= + + # Allow all projects with label name=top\-secret to use project p1 network + openshift cli adm pod\-network join\-projects \-\-to= \-\-selector='name=top\-secret' .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-pod-network-make-projects-global.1 b/docs/man/man1/openshift-cli-adm-pod-network-make-projects-global.1 index 6af82e2230e3..129e4ee16430 100644 --- a/docs/man/man1/openshift-cli-adm-pod-network-make-projects-global.1 +++ b/docs/man/man1/openshift-cli-adm-pod-network-make-projects-global.1 @@ -96,11 +96,11 @@ Allows projects to access all pods in the cluster and vice versa when using the .RS .nf - # Allow project p1 to access all pods in the cluster and vice versa - openshift cli adm pod\-network make\-projects\-global - - # Allow all projects with label name=share to access all pods in the cluster and vice versa - openshift cli adm pod\-network make\-projects\-global \-\-selector='name=share' + # Allow project p1 to access all pods in the cluster and vice versa + openshift cli adm pod\-network make\-projects\-global + + # Allow all projects with label name=share to access all pods in the cluster and vice versa + openshift cli adm pod\-network make\-projects\-global \-\-selector='name=share' .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-policy-add-role-to-user.1 b/docs/man/man1/openshift-cli-adm-policy-add-role-to-user.1 index 8ea02fcefcea..f3df87ce82d1 100644 --- a/docs/man/man1/openshift-cli-adm-policy-add-role-to-user.1 +++ b/docs/man/man1/openshift-cli-adm-policy-add-role-to-user.1 @@ -99,7 +99,7 @@ Add a role to users or serviceaccounts for the current project .nf # Add the 'view' role to user1 for the current project openshift cli adm policy add\-role\-to\-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project openshift cli adm policy add\-role\-to\-user edit \-z serviceaccount1 diff --git a/docs/man/man1/openshift-cli-adm-policy-add-scc-to-user.1 b/docs/man/man1/openshift-cli-adm-policy-add-scc-to-user.1 index dc81bccea000..0cdd3597ac3a 100644 --- a/docs/man/man1/openshift-cli-adm-policy-add-scc-to-user.1 +++ b/docs/man/man1/openshift-cli-adm-policy-add-scc-to-user.1 @@ -95,7 +95,7 @@ Add users or serviceaccount to a security context constraint .nf # Add the 'restricted' security context contraint to user1 and user2 openshift cli adm policy add\-scc\-to\-user restricted user1 user2 - + # Add the 'privileged' security context contraint to the service account serviceaccount1 in the current namespace openshift cli adm policy add\-scc\-to\-user privileged \-z serviceaccount1 diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 index 3507b2004b94..b45609494fcb 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 @@ -16,9 +16,7 @@ openshift cli adm policy reconcile\-cluster\-role\-bindings \- Update cluster ro Update cluster role bindings to match the recommended bootstrap policy .PP -This command will inspect the cluster role bindings against the recommended bootstrap policy. -Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding. -This command will not remove any additional cluster role bindings. +This command will inspect the cluster role bindings against the recommended bootstrap policy.Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding.This command will not remove any additional cluster role bindings. .PP You can see which recommended cluster role bindings have changed by choosing an output type. @@ -147,16 +145,16 @@ You can see which recommended cluster role bindings have changed by choosing an .nf # Display the names of cluster role bindings that would be modified openshift cli adm policy reconcile\-cluster\-role\-bindings \-o name - + # Display the cluster role bindings that would be modified, removing any extra subjects openshift cli adm policy reconcile\-cluster\-role\-bindings \-\-additive\-only=false - + # Update cluster role bindings that don't match the current defaults openshift cli adm policy reconcile\-cluster\-role\-bindings \-\-confirm - + # Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group openshift cli adm policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-exclude\-groups=system:authenticated - + # Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding openshift cli adm policy reconcile\-cluster\-role\-bindings \-\-confirm \-\-additive\-only=false diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 index 1381401c3872..a94f10bd76f9 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 @@ -16,9 +16,7 @@ openshift cli adm policy reconcile\-cluster\-roles \- Update cluster roles to ma Update cluster roles to match the recommended bootstrap policy .PP -This command will compare cluster roles against the recommended bootstrap policy. Any cluster role -that does not match will be replaced by the recommended bootstrap role. This command will not remove -any additional cluster role. +This command will compare cluster roles against the recommended bootstrap policy. Any cluster rolethat does not match will be replaced by the recommended bootstrap role. This command will not removeany additional cluster role. .PP Cluster roles with the annotation openshift.io/reconcile\-protect set to "true" are skipped. @@ -142,14 +140,14 @@ You can see which cluster roles have recommended changed by choosing an output t .nf # Display the names of cluster roles that would be modified openshift cli adm policy reconcile\-cluster\-roles \-o name - + # Add missing permissions to cluster roles that don't match the current defaults openshift cli adm policy reconcile\-cluster\-roles \-\-confirm - + # Add missing permissions and remove extra permissions from # cluster roles that don't match the current defaults openshift cli adm policy reconcile\-cluster\-roles \-\-additive\-only=false \-\-confirm - + # Display the union of the default and modified cluster roles openshift cli adm policy reconcile\-cluster\-roles \-\-additive\-only diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 index 3ac7eee237eb..204530d982da 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 @@ -16,12 +16,7 @@ openshift cli adm policy reconcile\-sccs \- Replace cluster SCCs to match the re Replace cluster SCCs to match the recommended bootstrap policy .PP -This command will inspect the cluster SCCs against the recommended bootstrap SCCs. -Any cluster SCC that does not match will be replaced by the recommended SCC. -This command will not remove any additional cluster SCCs. By default, this command -will not remove additional users and groups that have been granted access to the SCC and -will preserve existing priorities (but will always reconcile unset priorities and the policy -definition). +This command will inspect the cluster SCCs against the recommended bootstrap SCCs.Any cluster SCC that does not match will be replaced by the recommended SCC.This command will not remove any additional cluster SCCs. By default, this commandwill not remove additional users and groups that have been granted access to the SCC andwill preserve existing priorities (but will always reconcile unset priorities and the policydefinition). .PP You can see which cluster SCCs have recommended changes by choosing an output type. @@ -146,11 +141,11 @@ You can see which cluster SCCs have recommended changes by choosing an output ty .nf # Display the cluster SCCs that would be modified openshift cli adm policy reconcile\-sccs - + # Update cluster SCCs that don't match the current defaults preserving additional grants # for users and group and keeping any priorities that are already set openshift cli adm policy reconcile\-sccs \-\-confirm - + # Replace existing users, groups, and priorities that do not match defaults openshift cli adm policy reconcile\-sccs \-\-additive\-only=false \-\-confirm diff --git a/docs/man/man1/openshift-cli-adm-policy.1 b/docs/man/man1/openshift-cli-adm-policy.1 index acd0ec600bbb..80e557ce8aa0 100644 --- a/docs/man/man1/openshift-cli-adm-policy.1 +++ b/docs/man/man1/openshift-cli-adm-policy.1 @@ -16,13 +16,10 @@ openshift cli adm policy \- Manage policy Manage policy on the cluster .PP -These commands allow you to assign and manage the roles and policies that apply to users. The reconcile -commands allow you to reset and upgrade your system policies to the latest default policies. +These commands allow you to assign and manage the roles and policies that apply to users. The reconcilecommands allow you to reset and upgrade your system policies to the latest default policies. .PP -To see more information on roles and policies, use the 'get' and 'describe' commands on the following -resources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings', -and 'scc'. +To see more information on roles and policies, use the 'get' and 'describe' commands on the followingresources: 'clusterroles', 'clusterpolicy', 'clusterrolebindings', 'roles', 'policy', 'rolebindings',and 'scc'. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-prune-builds.1 b/docs/man/man1/openshift-cli-adm-prune-builds.1 index 36dfadc05de6..2c21534cc84d 100644 --- a/docs/man/man1/openshift-cli-adm-prune-builds.1 +++ b/docs/man/man1/openshift-cli-adm-prune-builds.1 @@ -16,8 +16,7 @@ openshift cli adm prune builds \- Remove old completed and failed builds Prune old completed and failed builds .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -116,7 +115,7 @@ By default, the prune operation performs a dry run making no changes to internal # Dry run deleting older completed and failed builds and also including # all builds whose associated BuildConfig no longer exists openshift cli adm prune builds \-\-orphans - + # To actually perform the prune operation, the confirm flag must be appended openshift cli adm prune builds \-\-orphans \-\-confirm diff --git a/docs/man/man1/openshift-cli-adm-prune-deployments.1 b/docs/man/man1/openshift-cli-adm-prune-deployments.1 index 757548a05452..cf6a0f68e406 100644 --- a/docs/man/man1/openshift-cli-adm-prune-deployments.1 +++ b/docs/man/man1/openshift-cli-adm-prune-deployments.1 @@ -16,8 +16,7 @@ openshift cli adm prune deployments \- Remove old completed and failed deploymen Prune old completed and failed deployments .PP -By default, the prune operation performs a dry run making no changes to the deployments. -A \-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to the deployments.A \-\-confirm flag is needed for changes to be effective. .SH OPTIONS @@ -115,7 +114,7 @@ A \-\-confirm flag is needed for changes to be effective. .nf # Dry run deleting all but the last complete deployment for every deployment config openshift cli adm prune deployments \-\-keep\-complete=1 - + # To actually perform the prune operation, the confirm flag must be appended openshift cli adm prune deployments \-\-keep\-complete=1 \-\-confirm diff --git a/docs/man/man1/openshift-cli-adm-prune-groups.1 b/docs/man/man1/openshift-cli-adm-prune-groups.1 index c0fae63b50de..a3458e2645a9 100644 --- a/docs/man/man1/openshift-cli-adm-prune-groups.1 +++ b/docs/man/man1/openshift-cli-adm-prune-groups.1 @@ -16,13 +16,7 @@ openshift cli adm prune groups \- Prune OpenShift groups referencing missing rec Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups openshift cli adm prune groups \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file openshift cli adm prune groups \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file openshift cli adm prune groups \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist openshift cli adm prune groups groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-prune-images.1 b/docs/man/man1/openshift-cli-adm-prune-images.1 index d16cc9f4b2f4..853198785d41 100644 --- a/docs/man/man1/openshift-cli-adm-prune-images.1 +++ b/docs/man/man1/openshift-cli-adm-prune-images.1 @@ -16,12 +16,10 @@ openshift cli adm prune images \- Remove unreferenced images Prune images no longer needed due to age and/or status .PP -By default, the prune operation performs a dry run making no changes to internal registry. A -\-\-confirm flag is needed for changes to be effective. +By default, the prune operation performs a dry run making no changes to internal registry. A\-\-confirm flag is needed for changes to be effective. .PP -Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete the -images. +Only a user with a cluster role system:image\-pruner or higher who is logged\-in will be able to actually delete theimages. .SH OPTIONS @@ -120,14 +118,14 @@ images. # See, what the prune command would delete if only images more than an hour old and obsoleted # by 3 newer revisions under the same tag were considered. openshift cli adm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m - + # To actually perform the prune operation, the confirm flag must be appended openshift cli adm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm - + # See, what the prune command would delete if we're interested in removing images # exceeding currently set LimitRanges ('openshift.io/Image') openshift cli adm prune images \-\-prune\-over\-size\-limit - + # To actually perform the prune operation, the confirm flag must be appended openshift cli adm prune images \-\-prune\-over\-size\-limit \-\-confirm diff --git a/docs/man/man1/openshift-cli-adm-prune.1 b/docs/man/man1/openshift-cli-adm-prune.1 index 75d4898a72fb..4427818fd964 100644 --- a/docs/man/man1/openshift-cli-adm-prune.1 +++ b/docs/man/man1/openshift-cli-adm-prune.1 @@ -16,8 +16,7 @@ openshift cli adm prune \- Remove older versions of resources from the server Remove older versions of resources from the server .PP -The commands here allow administrators to manage the older versions of resources on -the system by removing them. +The commands here allow administrators to manage the older versions of resources onthe system by removing them. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-registry.1 b/docs/man/man1/openshift-cli-adm-registry.1 index 5ebf979b1aa7..818b68c82d48 100644 --- a/docs/man/man1/openshift-cli-adm-registry.1 +++ b/docs/man/man1/openshift-cli-adm-registry.1 @@ -16,28 +16,16 @@ openshift cli adm registry \- Install the integrated Docker registry Install or configure an integrated Docker registry .PP -This command sets up a Docker registry integrated with your cluster to provide notifications when -images are pushed. With no arguments, the command will check for the existing registry service -called 'docker\-registry' and try to create it. If you want to test whether the registry has -been created add the \-\-dry\-run flag and the command will exit with 1 if the registry does not -exist. +This command sets up a Docker registry integrated with your cluster to provide notifications whenimages are pushed. With no arguments, the command will check for the existing registry servicecalled 'docker\-registry' and try to create it. If you want to test whether the registry hasbeen created add the \-\-dry\-run flag and the command will exit with 1 if the registry does notexist. .PP -To run a highly available registry, you should be using a remote storage mechanism like an -object store (several are supported by the Docker registry). The default Docker registry image -is configured to accept configuration as environment variables \- refer to the configuration file in -that image for more on setting up alternative storage. Once you've made those changes, you can -pass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setup -uses a local volume and the data will be lost if you delete the running pod. +To run a highly available registry, you should be using a remote storage mechanism like anobject store (several are supported by the Docker registry). The default Docker registry imageis configured to accept configuration as environment variables \- refer to the configuration file inthat image for more on setting up alternative storage. Once you've made those changes, you canpass \-\-replicas=2 or higher to ensure you have failover protection. The default registry setupuses a local volume and the data will be lost if you delete the running pod. .PP -If multiple ports are specified using the option \-\-ports, the first specified port will be -chosen for use as the REGISTRY\_HTTP\_ADDR and will be passed to Docker registry. +If multiple ports are specified using the option \-\-ports, the first specified port will bechosen for use as the REGISTRYHTTPADDR and will be passed to Docker registry. .PP -NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a new - installation. Some configuration beyond this command is still required to make - your registry persist data. +NOTE: This command is intended to simplify the tasks of setting up a Docker registry in a newinstallation. Some configuration beyond this command is still required to makeyour registry persist data. .SH OPTIONS @@ -191,16 +179,16 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .nf # Check if default Docker registry ("docker\-registry") has been created openshift cli adm registry \-\-dry\-run - + # See what the registry will look like if created openshift cli adm registry \-o yaml - + # Create a registry with two replicas if it does not exist openshift cli adm registry \-\-replicas=2 - + # Use a different registry image openshift cli adm registry \-\-images=myrepo/docker\-registry:mytag - + # Enforce quota and limits on images openshift cli adm registry \-\-enforce\-quota diff --git a/docs/man/man1/openshift-cli-adm-router.1 b/docs/man/man1/openshift-cli-adm-router.1 index 19e3792b44bd..57f43fc3dc48 100644 --- a/docs/man/man1/openshift-cli-adm-router.1 +++ b/docs/man/man1/openshift-cli-adm-router.1 @@ -16,17 +16,10 @@ openshift cli adm router \- Install a router Install or configure a router .PP -This command helps to setup a router to take edge traffic and balance it to -your application. With no arguments, the command will check for an existing router -service called 'router' and create one if it does not exist. If you want to test whether -a router has already been created add the \-\-dry\-run flag and the command will exit with -1 if the registry does not exist. +This command helps to setup a router to take edge traffic and balance it toyour application. With no arguments, the command will check for an existing routerservice called 'router' and create one if it does not exist. If you want to test whethera router has already been created add the \-\-dry\-run flag and the command will exit with1 if the registry does not exist. .PP -If a router does not exist with the given name, this command will -create a deployment configuration and service that will run the router. If you are -running your router in production, you should pass \-\-replicas=2 or higher to ensure -you have failover protection. +If a router does not exist with the given name, this command willcreate a deployment configuration and service that will run the router. If you arerunning your router in production, you should pass \-\-replicas=2 or higher to ensureyou have failover protection. .SH OPTIONS @@ -232,19 +225,18 @@ you have failover protection. .nf # Check the default router ("router") openshift cli adm router \-\-dry\-run - + # See what the router would look like if created openshift cli adm router \-o yaml - + # Create a router with two replicas if it does not exist openshift cli adm router router\-west \-\-replicas=2 - + # Use a different router image openshift cli adm router region\-west \-\-images=myrepo/somerouter:mytag - + # Run the router with a hint to the underlying implementation to \_not\_ expose statistics. openshift cli adm router router\-west \-\-stats\-port=0 - .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-taint.1 b/docs/man/man1/openshift-cli-adm-taint.1 index 7b6293b21641..79a184c832e7 100644 --- a/docs/man/man1/openshift-cli-adm-taint.1 +++ b/docs/man/man1/openshift-cli-adm-taint.1 @@ -16,11 +16,7 @@ openshift cli adm taint \- Update the taints on one or more nodes Update the taints on one or more nodes. .PP -A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. -The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The effect must be NoSchedule or PreferNoSchedule. -Currently taint can only apply to node. +A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.The effect must be NoSchedule or PreferNoSchedule.Currently taint can only apply to node. .SH OPTIONS @@ -152,16 +148,15 @@ Currently taint can only apply to node. .RS .nf - -# Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. -# If a taint with that key and effect already exists, its value is replaced as specified. -openshift cli adm taint nodes foo dedicated=special\-user:NoSchedule - -# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. -openshift cli adm taint nodes foo dedicated:NoSchedule\- - -# Remove from node 'foo' all the taints with key 'dedicated' -openshift cli adm taint nodes foo dedicated\- + # Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. + # If a taint with that key and effect already exists, its value is replaced as specified. + openshift cli adm taint nodes foo dedicated=special\-user:NoSchedule + + # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. + openshift cli adm taint nodes foo dedicated:NoSchedule\- + + # Remove from node 'foo' all the taints with key 'dedicated' + openshift cli adm taint nodes foo dedicated\- .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-top-images.1 b/docs/man/man1/openshift-cli-adm-top-images.1 index b80ffe2806fc..17f94596164f 100644 --- a/docs/man/man1/openshift-cli-adm-top-images.1 +++ b/docs/man/man1/openshift-cli-adm-top-images.1 @@ -16,8 +16,7 @@ openshift cli adm top images \- Show usage statistics for Images Show usage statistics for Images .PP -This command analyzes all the Images managed by the platform and presents current -usage statistics. +This command analyzes all the Images managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-top-imagestreams.1 b/docs/man/man1/openshift-cli-adm-top-imagestreams.1 index bb281eef85ad..c937852ac7d6 100644 --- a/docs/man/man1/openshift-cli-adm-top-imagestreams.1 +++ b/docs/man/man1/openshift-cli-adm-top-imagestreams.1 @@ -16,8 +16,7 @@ openshift cli adm top imagestreams \- Show usage statistics for ImageStreams Show usage statistics for ImageStreams .PP -This command analyzes all the ImageStreams managed by the platform and presents current -usage statistics. +This command analyzes all the ImageStreams managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-top-node.1 b/docs/man/man1/openshift-cli-adm-top-node.1 index 6aeec15279cb..505fb5eff19c 100644 --- a/docs/man/man1/openshift-cli-adm-top-node.1 +++ b/docs/man/man1/openshift-cli-adm-top-node.1 @@ -96,12 +96,11 @@ The top\-node command allows you to see the resource consumption of nodes. .RS .nf - -# Show metrics for all nodes -kubectl top node - -# Show metrics for a given node -kubectl top node NODE\_NAME + # Show metrics for all nodes + kubectl top node + + # Show metrics for a given node + kubectl top node NODE\_NAME .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-top-pod.1 b/docs/man/man1/openshift-cli-adm-top-pod.1 index 57e66cc9703d..a08953b5b90c 100644 --- a/docs/man/man1/openshift-cli-adm-top-pod.1 +++ b/docs/man/man1/openshift-cli-adm-top-pod.1 @@ -19,8 +19,7 @@ Display Resource (CPU/Memory/Storage) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. .PP -Due to the metrics pipeline delay, they may be unavailable for a few minutes -since pod creation. +Due to the metrics pipeline delay, they may be unavailable for a few minutessince pod creation. .SH OPTIONS @@ -108,18 +107,17 @@ since pod creation. .RS .nf - -# Show metrics for all pods in the default namespace -kubectl top pod - -# Show metrics for all pods in the given namespace -kubectl top pod \-\-namespace=NAMESPACE - -# Show metrics for a given pod and its containers -kubectl top pod POD\_NAME \-\-containers - -# Show metrics for the pods defined by label name=myLabel -kubectl top pod \-l name=myLabel + # Show metrics for all pods in the default namespace + kubectl top pod + + # Show metrics for all pods in the given namespace + kubectl top pod \-\-namespace=NAMESPACE + + # Show metrics for a given pod and its containers + kubectl top pod POD\_NAME \-\-containers + + # Show metrics for the pods defined by label name=myLabel + kubectl top pod \-l name=myLabel .fi .RE diff --git a/docs/man/man1/openshift-cli-adm-top.1 b/docs/man/man1/openshift-cli-adm-top.1 index b6242ff1f6a1..bb0fd770978c 100644 --- a/docs/man/man1/openshift-cli-adm-top.1 +++ b/docs/man/man1/openshift-cli-adm-top.1 @@ -16,8 +16,7 @@ openshift cli adm top \- Show usage statistics of resources on the server Show usage statistics of resources on the server .PP -This command analyzes resources managed by the platform and presents current -usage statistics. +This command analyzes resources managed by the platform and presents currentusage statistics. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-adm-uncordon.1 b/docs/man/man1/openshift-cli-adm-uncordon.1 index b3a3d778eaa6..e5403cddaef1 100644 --- a/docs/man/man1/openshift-cli-adm-uncordon.1 +++ b/docs/man/man1/openshift-cli-adm-uncordon.1 @@ -87,10 +87,8 @@ Mark node as schedulable. .RS .nf - -# Mark node "foo" as schedulable. -$ openshift cli adm uncordon foo - + # Mark node "foo" as schedulable. + $ openshift cli adm uncordon foo .fi .RE diff --git a/docs/man/man1/openshift-cli-adm.1 b/docs/man/man1/openshift-cli-adm.1 index 29a3c705776a..7c6a8553880a 100644 --- a/docs/man/man1/openshift-cli-adm.1 +++ b/docs/man/man1/openshift-cli-adm.1 @@ -16,8 +16,7 @@ openshift cli adm \- Tools for managing a cluster Administrative Commands .PP -Commands for managing a cluster are exposed here. Many administrative -actions involve interaction with the command\-line client as well. +Commands for managing a cluster are exposed here. Many administrativeactions involve interaction with the command\-line client as well. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-annotate.1 b/docs/man/man1/openshift-cli-annotate.1 index e044660a9383..66e422ef45cc 100644 --- a/docs/man/man1/openshift-cli-annotate.1 +++ b/docs/man/man1/openshift-cli-annotate.1 @@ -16,13 +16,7 @@ openshift cli annotate \- Update the annotations on a resource Update the annotations on one or more resources .PP -An annotation is a key/value pair that can hold larger (compared to a label), -and possibly not human\-readable, data. It is intended to store non\-identifying -auxiliary data, especially data manipulated by tools and system extensions. If -\-\-overwrite is true, then existing annotations can be overwritten, otherwise -attempting to overwrite an annotation will result in an error. If -\-\-resource\-version is specified, then updates will use this resource version, -otherwise the existing resource\-version will be used. +An annotation is a key/value pair that can hold larger (compared to a label),and possibly not human\-readable, data. It is intended to store non\-identifyingauxiliary data, especially data manipulated by tools and system extensions. If\-\-overwrite is true, then existing annotations can be overwritten, otherwiseattempting to overwrite an annotation will result in an error. If\-\-resource\-version is specified, then updates will use this resource version,otherwise the existing resource\-version will be used. .PP Run 'openshift cli types' for a list of valid resources. @@ -168,17 +162,17 @@ Run 'openshift cli types' for a list of valid resources. # Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied openshift cli annotate pods foo description='my frontend' - + # Update pod 'foo' with the annotation 'description' and the value # 'my frontend running nginx', overwriting any existing value. openshift cli annotate \-\-overwrite pods foo description='my frontend running nginx' - + # Update all pods in the namespace openshift cli annotate pods \-\-all description='my frontend running nginx' - + # Update pod 'foo' only if the resource is unchanged from version 1. openshift cli annotate pods foo description='my frontend running nginx' \-\-resource\-version=1 - + # Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the \-\-overwrite flag. openshift cli annotate pods foo description\- diff --git a/docs/man/man1/openshift-cli-apply.1 b/docs/man/man1/openshift-cli-apply.1 index 8b49f5f85787..7fe593562fb2 100644 --- a/docs/man/man1/openshift-cli-apply.1 +++ b/docs/man/man1/openshift-cli-apply.1 @@ -124,11 +124,11 @@ JSON and YAML formats are accepted. .RS .nf -# Apply the configuration in pod.json to a pod. -openshift cli apply \-f ./pod.json - -# Apply the JSON passed into stdin to a pod. -cat pod.json | openshift cli apply \-f \- + # Apply the configuration in pod.json to a pod. + openshift cli apply \-f ./pod.json + + # Apply the JSON passed into stdin to a pod. + cat pod.json | openshift cli apply \-f \- .fi .RE diff --git a/docs/man/man1/openshift-cli-attach.1 b/docs/man/man1/openshift-cli-attach.1 index 130959ef89d3..215006f353d3 100644 --- a/docs/man/man1/openshift-cli-attach.1 +++ b/docs/man/man1/openshift-cli-attach.1 @@ -16,8 +16,7 @@ openshift cli attach \- Attach to a running container Attach to a running container .PP -Attach the current shell to a remote container, returning output or setting up a full -terminal session. Can be used to debug containers and invoke interactive commands. +Attach the current shell to a remote container, returning output or setting up a fullterminal session. Can be used to debug containers and invoke interactive commands. .SH OPTIONS @@ -107,10 +106,10 @@ terminal session. Can be used to debug containers and invoke interactive command .nf # Get output from running pod 123456\-7890, using the first container by default openshift cli attach 123456\-7890 - + # Get output from ruby\-container from pod 123456\-7890 openshift cli attach 123456\-7890 \-c ruby\-container - + # Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 # and sends stdout/stderr from 'bash' back to the client openshift cli attach 123456\-7890 \-c ruby\-container \-i \-t diff --git a/docs/man/man1/openshift-cli-autoscale.1 b/docs/man/man1/openshift-cli-autoscale.1 index 889c3e5525c2..8da04a3215b2 100644 --- a/docs/man/man1/openshift-cli-autoscale.1 +++ b/docs/man/man1/openshift-cli-autoscale.1 @@ -16,9 +16,7 @@ openshift cli autoscale \- Autoscale a deployment config or replication controll Autoscale a deployment config or replication controller. .PP -Looks up a deployment config or replication controller by name and creates an autoscaler that uses -this deployment config or replication controller as a reference. An autoscaler can automatically -increase or decrease number of pods deployed within the system as needed. +Looks up a deployment config or replication controller by name and creates an autoscaler that usesthis deployment config or replication controller as a reference. An autoscaler can automaticallyincrease or decrease number of pods deployed within the system as needed. .SH OPTIONS @@ -170,10 +168,12 @@ increase or decrease number of pods deployed within the system as needed. .RS .nf - # Auto scale a deployment config "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: + # Auto scale a deployment config "foo", with the number of pods between 2 to + # 10, target CPU utilization at a default value that server applies: openshift cli autoscale dc/foo \-\-min=2 \-\-max=10 - - # Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80% + + # Auto scale a replication controller "foo", with the number of pods between + # 1 to 5, target CPU utilization at 80% openshift cli autoscale rc/foo \-\-max=5 \-\-cpu\-percent=80 .fi diff --git a/docs/man/man1/openshift-cli-cancel-build.1 b/docs/man/man1/openshift-cli-cancel-build.1 index db263be6189b..b358461cae7d 100644 --- a/docs/man/man1/openshift-cli-cancel-build.1 +++ b/docs/man/man1/openshift-cli-cancel-build.1 @@ -16,8 +16,7 @@ openshift cli cancel\-build \- Cancel running, pending, or new builds Cancel running, pending, or new builds .PP -This command requests a graceful shutdown of the build. There may be a delay between requesting -the build and the time the build is terminated. +This command requests a graceful shutdown of the build. There may be a delay between requestingthe build and the time the build is terminated. .SH OPTIONS @@ -107,16 +106,16 @@ the build and the time the build is terminated. .nf # Cancel the build with the given name openshift cli cancel\-build ruby\-build\-2 - + # Cancel the named build and print the build logs openshift cli cancel\-build ruby\-build\-2 \-\-dump\-logs - + # Cancel the named build and create a new one with the same parameters openshift cli cancel\-build ruby\-build\-2 \-\-restart - + # Cancel multiple builds openshift cli cancel\-build ruby\-build\-1 ruby\-build\-2 ruby\-build\-3 - + # Cancel all builds created from 'ruby\-build' build configuration that are in 'new' state openshift cli cancel\-build bc/ruby\-build \-\-state=new diff --git a/docs/man/man1/openshift-cli-cluster-down.1 b/docs/man/man1/openshift-cli-cluster-down.1 index d86a88e2f1ad..f58e09420f9c 100644 --- a/docs/man/man1/openshift-cli-cluster-down.1 +++ b/docs/man/man1/openshift-cli-cluster-down.1 @@ -16,8 +16,7 @@ openshift cli cluster down \- Stop OpenShift on Docker Stops the container running OpenShift on Docker and associated containers. .PP -If you started your OpenShift with a specific docker\-machine, you need to specify the -same machine using the \-\-docker\-machine argument. +If you started your OpenShift with a specific docker\-machine, you need to specify thesame machine using the \-\-docker\-machine argument. .SH OPTIONS @@ -97,14 +96,12 @@ same machine using the \-\-docker\-machine argument. .RS .nf - # Stop local Docker cluster openshift cli cluster down - + # Stop cluster running on Docker machine 'mymachine' openshift cli cluster down \-\-docker\-machine=mymachine - .fi .RE diff --git a/docs/man/man1/openshift-cli-cluster-up.1 b/docs/man/man1/openshift-cli-cluster-up.1 index ccb11b746034..2b1998c5820f 100644 --- a/docs/man/man1/openshift-cli-cluster-up.1 +++ b/docs/man/man1/openshift-cli-cluster-up.1 @@ -13,24 +13,16 @@ openshift cli cluster up \- Start OpenShift on Docker with reasonable defaults .SH DESCRIPTION .PP -Starts an OpenShift cluster using Docker containers, provisioning a registry, router, -initial templates, and a default project. +Starts an OpenShift cluster using Docker containers, provisioning a registry, router,initial templates, and a default project. .PP -This command will attempt to use an existing connection to a Docker daemon. Before running -the command, ensure that you can execure docker commands successfully (ie. 'docker ps'). +This command will attempt to use an existing connection to a Docker daemon. Before runningthe command, ensure that you can execure docker commands successfully (ie. 'docker ps'). .PP -Optionally, the command can create a new Docker machine for OpenShift using the VirtualBox -driver when the \-\-create\-machine argument is specified. The machine will be named 'openshift' -by default. To name the machine differently, use the \-\-docker\-machine=NAME argument. If the -\-\-docker\-machine=NAME argument is specified, but \-\-create\-machine is not, the command will attempt -to find an existing docker machine with that name and start it if it's not running. +Optionally, the command can create a new Docker machine for OpenShift using the VirtualBoxdriver when the \-\-create\-machine argument is specified. The machine will be named 'openshift'by default. To name the machine differently, use the \-\-docker\-machine=NAME argument. If the\-\-docker\-machine=NAME argument is specified, but \-\-create\-machine is not, the command will attemptto find an existing docker machine with that name and start it if it's not running. .PP -By default, the OpenShift cluster will be setup to use a routing suffix that ends in xip.io. -This is to allow dynamic host names to be created for routes. An alternate routing suffix -can be specified using the \-\-routing\-suffix flag. +By default, the OpenShift cluster will be setup to use a routing suffix that ends in xip.io.This is to allow dynamic host names to be created for routes. An alternate routing suffixcan be specified using the \-\-routing\-suffix flag. .PP A public hostname can also be specified for the server with the \-\-public\-hostname flag. @@ -169,20 +161,18 @@ A public hostname can also be specified for the server with the \-\-public\-host .RS .nf - # Start OpenShift on a new docker machine named 'openshift' openshift cli cluster up \-\-create\-machine - + # Start OpenShift using a specific public host name openshift cli cluster up \-\-public\-hostname=my.address.example.com - + # Start OpenShift and preserve data and config between restarts openshift cli cluster up \-\-host\-data\-dir=/mydata \-\-use\-existing\-config - + # Use a different set of images openshift cli cluster up \-\-image="registry.example.com/origin" \-\-version="v1.1" - .fi .RE diff --git a/docs/man/man1/openshift-cli-cluster.1 b/docs/man/man1/openshift-cli-cluster.1 index aeab0667cd64..8f14fe3f55ec 100644 --- a/docs/man/man1/openshift-cli-cluster.1 +++ b/docs/man/man1/openshift-cli-cluster.1 @@ -13,25 +13,19 @@ openshift cli cluster \- Start and stop OpenShift cluster .SH DESCRIPTION .PP -Manage a local OpenShift cluster. +Manage a local OpenShift cluster .PP -The OpenShift cluster will run as an all\-in\-one container on a Docker host. The Docker host -may be a local VM (ie. using docker\-machine on OS X and Windows clients), remote machine, or -the local Unix host. +The OpenShift cluster will run as an all\-in\-one container on a Docker host. The Docker hostmay be a local VM (ie. using docker\-machine on OS X and Windows clients), remote machine, orthe local Unix host. .PP -To use an existing Docker connection, ensure that Docker commands are working and that you -can create new containers. For OS X and Windows clients, a docker\-machine with the VirtualBox -driver can be created for you using the \-\-create\-machine option. +To use an existing Docker connection, ensure that Docker commands are working and that youcan create new containers. For OS X and Windows clients, a docker\-machine with the VirtualBoxdriver can be created for you using the \-\-create\-machine option. .PP -By default, etcd data will not be preserved between container restarts. If you wish to -preserve your data, specify a value for \-\-host\-data\-dir and the \-\-use\-existing\-config flag. +By default, etcd data will not be preserved between container restarts. If you wish topreserve your data, specify a value for \-\-host\-data\-dir and the \-\-use\-existing\-config flag. .PP -Default routes are setup using xip.io and the host ip of your cluster. To use a different -routing suffix, use the \-\-routing\-suffix flag. +Default routes are setup using xip.io and the host ip of your cluster. To use a differentrouting suffix, use the \-\-routing\-suffix flag. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-completion.1 b/docs/man/man1/openshift-cli-completion.1 index 2124752cf2cc..d88d97caed9a 100644 --- a/docs/man/man1/openshift-cli-completion.1 +++ b/docs/man/man1/openshift-cli-completion.1 @@ -13,8 +13,7 @@ openshift cli completion \- Output shell completion code for the given shell (ba .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift cli commands. +This command prints shell code which must be evaluated to provide interactivecompletion of openshift cli commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -91,18 +90,19 @@ completion of openshift cli commands. # Generate the openshift cli completion code for bash openshift cli completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion openshift cli completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(openshift cli completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/openshift-cli-config-current-context.1 b/docs/man/man1/openshift-cli-config-current-context.1 index db5d2e9176ad..b1c42e4c6a9b 100644 --- a/docs/man/man1/openshift-cli-config-current-context.1 +++ b/docs/man/man1/openshift-cli-config-current-context.1 @@ -87,7 +87,6 @@ Displays the current\-context .RS .nf - # Display the current\-context openshift cli config current\-context diff --git a/docs/man/man1/openshift-cli-config-set-cluster.1 b/docs/man/man1/openshift-cli-config-set-cluster.1 index 22dbdc57bee8..2686ba763fb3 100644 --- a/docs/man/man1/openshift-cli-config-set-cluster.1 +++ b/docs/man/man1/openshift-cli-config-set-cluster.1 @@ -13,8 +13,7 @@ openshift cli config set\-cluster \- Sets a cluster entry in kubeconfig .SH DESCRIPTION .PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a cluster entry in kubeconfig.Specifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -94,7 +93,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set only the server field on the e2e cluster entry without touching other values. openshift cli config set\-cluster e2e \-\-server=https://1.2.3.4 diff --git a/docs/man/man1/openshift-cli-config-set-context.1 b/docs/man/man1/openshift-cli-config-set-context.1 index ff7522a2fe87..4ceca2500380 100644 --- a/docs/man/man1/openshift-cli-config-set-context.1 +++ b/docs/man/man1/openshift-cli-config-set-context.1 @@ -13,8 +13,7 @@ openshift cli config set\-context \- Sets a context entry in kubeconfig .SH DESCRIPTION .PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. +Sets a context entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values for those fields. .SH OPTIONS @@ -90,7 +89,6 @@ Specifying a name that already exists will merge new fields on top of existing v .RS .nf - # Set the user field on the gce context entry without touching other values openshift cli config set\-context gce \-\-user=cluster\-admin diff --git a/docs/man/man1/openshift-cli-config-set-credentials.1 b/docs/man/man1/openshift-cli-config-set-credentials.1 index 8bf471535448..827ff6473bee 100644 --- a/docs/man/man1/openshift-cli-config-set-credentials.1 +++ b/docs/man/man1/openshift-cli-config-set-credentials.1 @@ -13,20 +13,16 @@ openshift cli config set\-credentials \- Sets a user entry in kubeconfig .SH DESCRIPTION .PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. +Sets a user entry in kubeconfigSpecifying a name that already exists will merge new fields on top of existing values. .PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile +Client\-certificate flags:\-\-client\-certificate=certfile \-\-client\-key=keyfile .PP -Bearer token flags: - \-\-token=bearer\_token +Bearer token flags:\-\-token=bearer\_token .PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password +Basic auth flags:\-\-username=basicuser \-\-password=basicpassword .PP Bearer token and basic auth are mutually exclusive. @@ -125,7 +121,6 @@ Bearer token and basic auth are mutually exclusive. .RS .nf - # Set only the "client\-key" field on the "cluster\-admin" # entry, without touching other values: openshift cli config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key diff --git a/docs/man/man1/openshift-cli-config-set.1 b/docs/man/man1/openshift-cli-config-set.1 index 27d6b541f33e..a28106d3d46f 100644 --- a/docs/man/man1/openshift-cli-config-set.1 +++ b/docs/man/man1/openshift-cli-config-set.1 @@ -13,9 +13,7 @@ openshift cli config set \- Sets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. +Sets an individual value in a kubeconfig filePROPERTYNAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.PROPERTYVALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-config-unset.1 b/docs/man/man1/openshift-cli-config-unset.1 index bf4f9d538cfd..beaf8dc83552 100644 --- a/docs/man/man1/openshift-cli-config-unset.1 +++ b/docs/man/man1/openshift-cli-config-unset.1 @@ -13,8 +13,7 @@ openshift cli config unset \- Unsets an individual value in a kubeconfig file .SH DESCRIPTION .PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. +Unsets an individual value in a kubeconfig filePROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-config-view.1 b/docs/man/man1/openshift-cli-config-view.1 index 505062894e2f..24add30c72f3 100644 --- a/docs/man/man1/openshift-cli-config-view.1 +++ b/docs/man/man1/openshift-cli-config-view.1 @@ -140,7 +140,6 @@ You can use \-\-output jsonpath={...} to extract specific values using a jsonpat .RS .nf - # Show Merged kubeconfig settings. openshift cli config view diff --git a/docs/man/man1/openshift-cli-config.1 b/docs/man/man1/openshift-cli-config.1 index d9a72eede07b..52f48f436426 100644 --- a/docs/man/man1/openshift-cli-config.1 +++ b/docs/man/man1/openshift-cli-config.1 @@ -16,9 +16,7 @@ openshift cli config \- Change configuration files for the client Manage the client config files .PP -The client stores configuration in the current user's home directory (under the .kube directory as -config). When you login the first time, a new config file is created, and subsequent project changes with the -'project' command will set the current context. These subcommands allow you to manage the config directly. +The client stores configuration in the current user's home directory (under the .kube directory asconfig). When you login the first time, a new config file is created, and subsequent project changes with the'project' command will set the current context. These subcommands allow you to manage the config directly. .PP Reference: diff --git a/docs/man/man1/openshift-cli-convert.1 b/docs/man/man1/openshift-cli-convert.1 index ef223c7d11c7..eccba33c21e1 100644 --- a/docs/man/man1/openshift-cli-convert.1 +++ b/docs/man/man1/openshift-cli-convert.1 @@ -13,17 +13,13 @@ openshift cli convert \- Convert config files between different API versions .SH DESCRIPTION .PP -Convert config files between different API versions. Both YAML -and JSON formats are accepted. +Convert config files between different API versions. Both YAMLand JSON formats are accepted. .PP -The command takes filename, directory, or URL as input, and convert it into format -of version specified by \-\-output\-version flag. If target version is not specified or -not supported, convert to latest version. +The command takes filename, directory, or URL as input, and convert it into formatof version specified by \-\-output\-version flag. If target version is not specified ornot supported, convert to latest version. .PP -The default output will be printed to stdout in YAML format. One can use \-o option -to change to output destination. +The default output will be printed to stdout in YAML format. One can use \-o optionto change to output destination. .SH OPTIONS @@ -157,15 +153,14 @@ to change to output destination. .nf # Convert 'pod.yaml' to latest version and print to stdout. openshift cli convert \-f pod.yaml - + # Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in json format. openshift cli convert \-f pod.yaml \-\-local \-o json - + # Convert all files under current directory to latest version and create them all. openshift cli convert \-f . | openshift cli create \-f \- - .fi .RE diff --git a/docs/man/man1/openshift-cli-create-configmap.1 b/docs/man/man1/openshift-cli-create-configmap.1 index bf0e317462d4..9fa71d492261 100644 --- a/docs/man/man1/openshift-cli-create-configmap.1 +++ b/docs/man/man1/openshift-cli-create-configmap.1 @@ -19,13 +19,10 @@ Create a configmap based on a file, directory, or specified literal value. A single configmap may package one or more key/value pairs. .PP -When creating a configmap based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. +When creating a configmap based on a file, the key will default to the basename of the file, and the value willdefault to the file content. If the basename is an invalid key, you may specify an alternate key. .PP -When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be -packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). +When creating a configmap based on a directory, each file whose basename is a valid key in the directory will bepackaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories,symlinks, devices, pipes, etc). .SH OPTIONS @@ -161,7 +158,6 @@ symlinks, devices, pipes, etc). .RS .nf - # Create a new configmap named my\-config with keys for each file in folder bar openshift cli create configmap my\-config \-\-from\-file=path/to/bar diff --git a/docs/man/man1/openshift-cli-create-deployment.1 b/docs/man/man1/openshift-cli-create-deployment.1 index 555391da2775..79a73e993faf 100644 --- a/docs/man/man1/openshift-cli-create-deployment.1 +++ b/docs/man/man1/openshift-cli-create-deployment.1 @@ -145,7 +145,6 @@ Create a deployment with the specified name. .RS .nf - # Create a new deployment named my\-dep that runs the busybox image. openshift cli create deployment my\-dep \-\-image=busybox diff --git a/docs/man/man1/openshift-cli-create-identity.1 b/docs/man/man1/openshift-cli-create-identity.1 index afd8a46b3bd4..fa796c873232 100644 --- a/docs/man/man1/openshift-cli-create-identity.1 +++ b/docs/man/man1/openshift-cli-create-identity.1 @@ -16,13 +16,10 @@ openshift cli create identity \- Manually create an identity (only needed if aut This command can be used to create an identity object. .PP -Typically, identities are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), identities must -be created manually. +Typically, identities are created automatically during login. If automaticcreation is disabled (by using the "lookup" mapping method), identities mustbe created manually. .PP -Corresponding user and useridentitymapping objects must also be created -to allow logging in with the created identity. +Corresponding user and useridentitymapping objects must also be createdto allow logging in with the created identity. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-imagestream.1 b/docs/man/man1/openshift-cli-create-imagestream.1 index abc1870b8abf..5e19c77b5ad8 100644 --- a/docs/man/man1/openshift-cli-create-imagestream.1 +++ b/docs/man/man1/openshift-cli-create-imagestream.1 @@ -16,8 +16,7 @@ openshift cli create imagestream \- Create a new empty image stream. Create a new image stream .PP -Image streams allow you to track, tag, and import images from other registries. They also define an -access controlled destination that you can push images to. +Image streams allow you to track, tag, and import images from other registries. They also define anaccess controlled destination that you can push images to. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-namespace.1 b/docs/man/man1/openshift-cli-create-namespace.1 index a04c8dd07ae3..8dc5280d416d 100644 --- a/docs/man/man1/openshift-cli-create-namespace.1 +++ b/docs/man/man1/openshift-cli-create-namespace.1 @@ -141,7 +141,6 @@ Create a namespace with the specified name. .RS .nf - # Create a new namespace named my\-namespace openshift cli create namespace my\-namespace diff --git a/docs/man/man1/openshift-cli-create-route-edge.1 b/docs/man/man1/openshift-cli-create-route-edge.1 index 4076cb8cab15..39c9113866a3 100644 --- a/docs/man/man1/openshift-cli-create-route-edge.1 +++ b/docs/man/man1/openshift-cli-create-route-edge.1 @@ -16,8 +16,7 @@ openshift cli create route edge \- Create a route that uses edge TLS termination Create a route that uses edge TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that thegenerated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route-passthrough.1 b/docs/man/man1/openshift-cli-create-route-passthrough.1 index fc9bf0aa7cb7..41799f7354e3 100644 --- a/docs/man/man1/openshift-cli-create-route-passthrough.1 +++ b/docs/man/man1/openshift-cli-create-route-passthrough.1 @@ -16,8 +16,7 @@ openshift cli create route passthrough \- Create a route that uses passthrough T Create a route that uses passthrough TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. +Specify the service (either just its name or using type/name syntax) that thegenerated route should expose via the \-\-service flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route-reencrypt.1 b/docs/man/man1/openshift-cli-create-route-reencrypt.1 index cedff409c5d5..11cefc41da3d 100644 --- a/docs/man/man1/openshift-cli-create-route-reencrypt.1 +++ b/docs/man/man1/openshift-cli-create-route-reencrypt.1 @@ -16,9 +16,7 @@ openshift cli create route reencrypt \- Create a route that uses reencrypt TLS t Create a route that uses reencrypt TLS termination .PP -Specify the service (either just its name or using type/name syntax) that the -generated route should expose via the \-\-service flag. A destination CA certificate -is needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. +Specify the service (either just its name or using type/name syntax) that thegenerated route should expose via the \-\-service flag. A destination CA certificateis needed for reencrypt routes, specify one with the \-\-dest\-ca\-cert flag. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-route.1 b/docs/man/man1/openshift-cli-create-route.1 index 0e2a9b3b7024..93a1da361aee 100644 --- a/docs/man/man1/openshift-cli-create-route.1 +++ b/docs/man/man1/openshift-cli-create-route.1 @@ -16,8 +16,7 @@ openshift cli create route \- Expose containers externally via secured routes Expose containers externally via secured routes .PP -Three types of secured routes are supported: edge, passthrough, and reencrypt. -If you wish to create unsecured routes, see "openshift cli expose \-h" +Three types of secured routes are supported: edge, passthrough, and reencrypt.If you wish to create unsecured routes, see "openshift cli expose \-h" .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-create-secret-docker-registry.1 b/docs/man/man1/openshift-cli-create-secret-docker-registry.1 index 351a4ec174fa..d20cb7ff8f5c 100644 --- a/docs/man/man1/openshift-cli-create-secret-docker-registry.1 +++ b/docs/man/man1/openshift-cli-create-secret-docker-registry.1 @@ -19,15 +19,10 @@ Create a new secret for use with Docker registries. Dockercfg secrets are used to authenticate against Docker registries. .PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. +When using the Docker command line to push images, you can authenticate to a given registry by running'docker login DOCKERREGISTRYSERVER \-\-username=DOCKERUSER \-\-password=DOCKERPASSWORD \-\-email=DOCKER\_EMAIL'.That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands toauthenticate to the registry. .PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. +When creating applications, you may have a Docker registry that requires authentication. In order for thenodes to pull images on your behalf, they have to have the credentials. You can provide this informationby creating a dockercfg secret and attaching it to your service account. .SH OPTIONS @@ -176,7 +171,6 @@ by creating a dockercfg secret and attaching it to your service account. .RS .nf - # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: openshift cli create secret docker\-registry my\-secret \-\-docker\-server=DOCKER\_REGISTRY\_SERVER \-\-docker\-username=DOCKER\_USER \-\-docker\-password=DOCKER\_PASSWORD \-\-docker\-email=DOCKER\_EMAIL diff --git a/docs/man/man1/openshift-cli-create-secret-generic.1 b/docs/man/man1/openshift-cli-create-secret-generic.1 index d367f0b2934a..784bac39c7b4 100644 --- a/docs/man/man1/openshift-cli-create-secret-generic.1 +++ b/docs/man/man1/openshift-cli-create-secret-generic.1 @@ -19,13 +19,10 @@ Create a secret based on a file, directory, or specified literal value. A single secret may package one or more key/value pairs. .PP -When creating a secret based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. +When creating a secret based on a file, the key will default to the basename of the file, and the value willdefault to the file content. If the basename is an invalid key, you may specify an alternate key. .PP -When creating a secret based on a directory, each file whose basename is a valid key in the directory will be -packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). +When creating a secret based on a directory, each file whose basename is a valid key in the directory will bepackaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories,symlinks, devices, pipes, etc). .SH OPTIONS @@ -165,7 +162,6 @@ symlinks, devices, pipes, etc). .RS .nf - # Create a new secret named my\-secret with keys for each file in folder bar openshift cli create secret generic my\-secret \-\-from\-file=path/to/bar diff --git a/docs/man/man1/openshift-cli-create-secret-tls.1 b/docs/man/man1/openshift-cli-create-secret-tls.1 index 992a24ed56a1..5553b6cb87cb 100644 --- a/docs/man/man1/openshift-cli-create-secret-tls.1 +++ b/docs/man/man1/openshift-cli-create-secret-tls.1 @@ -152,7 +152,6 @@ The public/private key pair must exist before hand. The public key certificate m .RS .nf - # Create a new TLS secret named tls\-secret with the given key pair: openshift cli create secret tls tls\-secret \-\-cert=path/to/tls.cert \-\-key=path/to/tls.key diff --git a/docs/man/man1/openshift-cli-create-service-clusterip.1 b/docs/man/man1/openshift-cli-create-service-clusterip.1 index 12d36f75923d..77245f0dfab3 100644 --- a/docs/man/man1/openshift-cli-create-service-clusterip.1 +++ b/docs/man/man1/openshift-cli-create-service-clusterip.1 @@ -149,7 +149,6 @@ Create a clusterIP service with the specified name. .RS .nf - # Create a new clusterIP service named my\-cs openshift cli create service clusterip my\-cs \-\-tcp=5678:8080 diff --git a/docs/man/man1/openshift-cli-create-service-loadbalancer.1 b/docs/man/man1/openshift-cli-create-service-loadbalancer.1 index 40a8329085e7..73a82aa8ce06 100644 --- a/docs/man/man1/openshift-cli-create-service-loadbalancer.1 +++ b/docs/man/man1/openshift-cli-create-service-loadbalancer.1 @@ -145,7 +145,6 @@ Create a LoadBalancer service with the specified name. .RS .nf - # Create a new nodeport service named my\-lbs openshift cli create service loadbalancer my\-lbs \-\-tcp=5678:8080 diff --git a/docs/man/man1/openshift-cli-create-service-nodeport.1 b/docs/man/man1/openshift-cli-create-service-nodeport.1 index 33fbf8d9e9e4..11afb4e52af6 100644 --- a/docs/man/man1/openshift-cli-create-service-nodeport.1 +++ b/docs/man/man1/openshift-cli-create-service-nodeport.1 @@ -145,7 +145,6 @@ Create a nodeport service with the specified name. .RS .nf - # Create a new nodeport service named my\-ns openshift cli create service nodeport my\-ns \-\-tcp=5678:8080 diff --git a/docs/man/man1/openshift-cli-create-serviceaccount.1 b/docs/man/man1/openshift-cli-create-serviceaccount.1 index b20e7d3f4658..a1a1f9325f80 100644 --- a/docs/man/man1/openshift-cli-create-serviceaccount.1 +++ b/docs/man/man1/openshift-cli-create-serviceaccount.1 @@ -145,7 +145,6 @@ Create a service account with the specified name. .RS .nf - # Create a new service account named my\-service\-account $ openshift cli create serviceaccount my\-service\-account diff --git a/docs/man/man1/openshift-cli-create-user.1 b/docs/man/man1/openshift-cli-create-user.1 index 2d40e83701f2..509f855193ca 100644 --- a/docs/man/man1/openshift-cli-create-user.1 +++ b/docs/man/man1/openshift-cli-create-user.1 @@ -16,13 +16,10 @@ openshift cli create user \- Manually create a user (only needed if automatic cr This command can be used to create a user object. .PP -Typically, users are created automatically during login. If automatic -creation is disabled (by using the "lookup" mapping method), users must -be created manually. +Typically, users are created automatically during login. If automaticcreation is disabled (by using the "lookup" mapping method), users mustbe created manually. .PP -Corresponding identity and useridentitymapping objects must also be created -to allow logging in as the created user. +Corresponding identity and useridentitymapping objects must also be createdto allow logging in as the created user. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-create-useridentitymapping.1 b/docs/man/man1/openshift-cli-create-useridentitymapping.1 index 1ab32cdb8a76..c8a8e178542d 100644 --- a/docs/man/man1/openshift-cli-create-useridentitymapping.1 +++ b/docs/man/man1/openshift-cli-create-useridentitymapping.1 @@ -13,10 +13,7 @@ openshift cli create useridentitymapping \- Manually map an identity to a user. .SH DESCRIPTION .PP -Typically, identities are automatically mapped to users during login. If automatic -mapping is disabled (by using the "lookup" mapping method), or a mapping needs to -be manually established between an identity and a user, this command can be used -to create a useridentitymapping object. +Typically, identities are automatically mapped to users during login. If automaticmapping is disabled (by using the "lookup" mapping method), or a mapping needs tobe manually established between an identity and a user, this command can be usedto create a useridentitymapping object. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-debug.1 b/docs/man/man1/openshift-cli-debug.1 index c73077322d0e..7e7b0604c2e3 100644 --- a/docs/man/man1/openshift-cli-debug.1 +++ b/docs/man/man1/openshift-cli-debug.1 @@ -16,27 +16,16 @@ openshift cli debug \- Launch a new instance of a pod for debugging Launch a command shell to debug a running application .PP -When debugging images and setup problems, it's useful to get an exact copy of a running -pod configuration and troubleshoot with a shell. Since a pod that is failing may not be -started and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy to -create a carbon copy of that setup. +When debugging images and setup problems, it's useful to get an exact copy of a runningpod configuration and troubleshoot with a shell. Since a pod that is failing may not bestarted and not accessible to 'rsh' or 'exec', the 'debug' command makes it easy tocreate a carbon copy of that setup. .PP -The default mode is to start a shell inside of the first container of the referenced pod, -replication controller, or deployment config. The started pod will be a copy of your -source pod, with labels stripped, the command changed to '/bin/sh', and readiness and -liveness checks disabled. If you just want to run a command, add '\-\-' and a command to -run. Passing a command will not create a TTY or send STDIN by default. Other flags are -supported for altering the container or pod in common ways. +The default mode is to start a shell inside of the first container of the referenced pod,replication controller, or deployment config. The started pod will be a copy of yoursource pod, with labels stripped, the command changed to '/bin/sh', and readiness andliveness checks disabled. If you just want to run a command, add '\-\-' and a command torun. Passing a command will not create a TTY or send STDIN by default. Other flags aresupported for altering the container or pod in common ways. .PP -A common problem running containers is a security policy that prohibits you from running -as a root user on the cluster. You can use this command to test running a pod as -non\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). +A common problem running containers is a security policy that prohibits you from runningas a root user on the cluster. You can use this command to test running a pod asnon\-root (with \-\-as\-user) or to run a non\-root pod as root (with \-\-as\-root). .PP -The debug pod is deleted when the the remote command completes or the user interrupts -the shell. +The debug pod is deleted when the the remote command completes or the user interruptsthe shell. .SH OPTIONS @@ -179,16 +168,15 @@ the shell. .RS .nf - # Debug a currently running deployment openshift cli debug dc/test - + # Test running a deployment as a non\-root user openshift cli debug dc/test \-\-as\-user=1000000 - + # Debug a specific failing container by running the env command in the 'second' container openshift cli debug dc/test \-c second \-\- /bin/env - + # See the pod that would be created to debug openshift cli debug dc/test \-o yaml diff --git a/docs/man/man1/openshift-cli-delete.1 b/docs/man/man1/openshift-cli-delete.1 index ce018bf7db0a..d83ac032632f 100644 --- a/docs/man/man1/openshift-cli-delete.1 +++ b/docs/man/man1/openshift-cli-delete.1 @@ -19,13 +19,10 @@ Delete a resource JSON and YAML formats are accepted. .PP -If both a filename and command line arguments are passed, the command line -arguments are used and the filename is ignored. +If both a filename and command line arguments are passed, the command linearguments are used and the filename is ignored. .PP -Note that the delete command does NOT do resource version checks, so if someone -submits an update to a resource right when you submit a delete, their update -will be lost along with the rest of the resource. +Note that the delete command does NOT do resource version checks, so if someonesubmits an update to a resource right when you submit a delete, their updatewill be lost along with the rest of the resource. .SH OPTIONS @@ -147,21 +144,21 @@ will be lost along with the rest of the resource. .nf # Delete a pod using the type and ID specified in pod.json. openshift cli delete \-f pod.json - + # Delete a pod based on the type and ID in the JSON passed into stdin. cat pod.json | openshift cli delete \-f \- - + # Delete pods and services with label name=myLabel. openshift cli delete pods,services \-l name=myLabel - + # Delete a pod with name node\-1\-vsjnm. openshift cli delete pod node\-1\-vsjnm - + # Delete all resources associated with a running app, includes # buildconfig,deploymentconfig,service,imagestream,route and pod, # where 'appName' is listed in 'Labels' of 'oc describe [resource] [resource name]' output. openshift cli delete all \-l app=appName - + # Delete all pods openshift cli delete pods \-\-all diff --git a/docs/man/man1/openshift-cli-deploy.1 b/docs/man/man1/openshift-cli-deploy.1 index 784585db556a..407b006fe829 100644 --- a/docs/man/man1/openshift-cli-deploy.1 +++ b/docs/man/man1/openshift-cli-deploy.1 @@ -16,36 +16,23 @@ openshift cli deploy \- View, start, cancel, or retry a deployment View, start, cancel, or retry a deployment .PP -This command allows you to control a deployment config. Each individual deployment is exposed -as a new replication controller, and the deployment process manages scaling down old deployments -and scaling up new ones. Use 'openshift cli rollback' to rollback to any previous deployment. +This command allows you to control a deployment config. Each individual deployment is exposedas a new replication controller, and the deployment process manages scaling down old deploymentsand scaling up new ones. Use 'openshift cli rollback' to rollback to any previous deployment. .PP There are several deployment strategies defined: .IP .IP -\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the number -of old deployments. If one of the new deployed pods never becomes "ready", the new deployment -will be rolled back (scaled down to zero). Use when your application can tolerate two versions -of code running at the same time (many web applications, scalable databases) +\(bu Rolling (default) \- scales up the new deployment in stages, gradually reducing the numberof old deployments. If one of the new deployed pods never becomes "ready", the new deploymentwill be rolled back (scaled down to zero). Use when your application can tolerate two versionsof code running at the same time (many web applications, scalable databases) .IP -\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full. -Use when your application cannot tolerate two versions of code running at the same time +\(bu Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.Use when your application cannot tolerate two versions of code running at the same time .IP \(bu Custom \- run your own deployment process inside a Docker container using your own scripts. .PP -If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may -never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment. -If a deployment config has completed deploying successfully at least once in the past, it would be -automatically rolled back in the event of a new failed deployment. Note that you would still need -to update the erroneous deployment config in order to have its template persisted across your -application. +If a deployment fails, you may opt to retry it (if the error was transient). Some deployments maynever successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment.If a deployment config has completed deploying successfully at least once in the past, it would beautomatically rolled back in the event of a new failed deployment. Note that you would still needto update the erroneous deployment config in order to have its template persisted across yourapplication. .PP -If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effort -operation and may take some time to complete. It’s possible the deployment will partially or totally -complete before the cancellation is effective. In such a case an appropriate event will be emitted. +If you want to cancel a running deployment, use '\-\-cancel' but keep in mind that this is a best\-effortoperation and may take some time to complete. It’s possible the deployment will partially or totallycomplete before the cancellation is effective. In such a case an appropriate event will be emitted. .PP If no options are given, shows information about the latest deployment. @@ -146,17 +133,17 @@ If no options are given, shows information about the latest deployment. .nf # Display the latest deployment for the 'database' deployment config openshift cli deploy database - + # Start a new deployment based on the 'database' openshift cli deploy database \-\-latest - + # Start a new deployment and follow its log openshift cli deploy database \-\-latest \-\-follow - + # Retry the latest failed deployment based on 'frontend' # The deployer pod and any hook pods are deleted for the latest failed deployment openshift cli deploy frontend \-\-retry - + # Cancel the in\-progress deployment based on 'frontend' openshift cli deploy frontend \-\-cancel diff --git a/docs/man/man1/openshift-cli-describe.1 b/docs/man/man1/openshift-cli-describe.1 index 1324f46626a8..36d78d240a37 100644 --- a/docs/man/man1/openshift-cli-describe.1 +++ b/docs/man/man1/openshift-cli-describe.1 @@ -16,8 +16,7 @@ openshift cli describe \- Show details of a specific resource or group of resour Show details of a specific resource .PP -This command joins many API calls together to form a detailed description of a -given resource. +This command joins many API calls together to form a detailed description of agiven resource. .SH OPTIONS @@ -119,7 +118,7 @@ given resource. .nf # Provide details about the ruby\-22\-centos7 image repository openshift cli describe imageRepository ruby\-22\-centos7 - + # Provide details about the ruby\-sample\-build build configuration openshift cli describe bc ruby\-sample\-build diff --git a/docs/man/man1/openshift-cli-edit.1 b/docs/man/man1/openshift-cli-edit.1 index 32e8def08722..103c28b1bf19 100644 --- a/docs/man/man1/openshift-cli-edit.1 +++ b/docs/man/man1/openshift-cli-edit.1 @@ -16,25 +16,13 @@ openshift cli edit \- Edit a resource on the server Edit a resource from the default editor .PP -The edit command allows you to directly edit any API resource you can retrieve via the -command line tools. It will open the editor defined by your OC\_EDITOR, or EDITOR environment -variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple -objects, although changes are applied one at a time. The command accepts filenames as well -as command line arguments, although the files you point to must be previously saved versions -of resources. +The edit command allows you to directly edit any API resource you can retrieve via thecommand line tools. It will open the editor defined by your OC\_EDITOR, or EDITOR environmentvariables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multipleobjects, although changes are applied one at a time. The command accepts filenames as wellas command line arguments, although the files you point to must be previously saved versionsof resources. .PP -The files to edit will be output in the default API version, or a version specified -by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON -pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, -otherwise the default for your operating system will be used. +The files to edit will be output in the default API version, or a version specifiedby \-\-output\-version. The default format is YAML \- if you would like to edit in JSONpass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings,otherwise the default for your operating system will be used. .PP -In the event an error occurs while updating, a temporary file will be created on disk -that contains your unapplied changes. The most common error when updating a resource -is another editor changing the resource on the server. When this occurs, you will have -to apply your changes to the newer version of the resource, or update your temporary -saved copy to include the latest resource version. +In the event an error occurs while updating, a temporary file will be created on diskthat contains your unapplied changes. The most common error when updating a resourceis another editor changing the resource on the server. When this occurs, you will haveto apply your changes to the newer version of the resource, or update your temporarysaved copy to include the latest resource version. .SH OPTIONS @@ -152,13 +140,13 @@ saved copy to include the latest resource version. .nf # Edit the service named 'docker\-registry': openshift cli edit svc/docker\-registry - + # Edit the DeploymentConfig named 'my\-deployment': openshift cli edit dc/my\-deployment - + # Use an alternative editor OC\_EDITOR="nano" openshift cli edit dc/my\-deployment - + # Edit the service 'docker\-registry' in JSON using the v1 API format: openshift cli edit svc/docker\-registry \-\-output\-version=v1 \-o json diff --git a/docs/man/man1/openshift-cli-env.1 b/docs/man/man1/openshift-cli-env.1 index 3a44478b2cd3..eb0691bff825 100644 --- a/docs/man/man1/openshift-cli-env.1 +++ b/docs/man/man1/openshift-cli-env.1 @@ -143,32 +143,32 @@ DEPRECATED: This command has been moved to "openshift cli set env" .nf # Update deployment 'registry' with a new environment variable openshift cli env dc/registry STORAGE\_DIR=/local - + # List the environment variables defined on a build config 'sample\-build' openshift cli env bc/sample\-build \-\-list - + # List the environment variables defined on all pods openshift cli env pods \-\-all \-\-list - + # Output modified build config in YAML, and does not alter the object on the server openshift cli env bc/sample\-build STORAGE\_DIR=/data \-o yaml - + # Update all containers in all replication controllers in the project to have ENV=prod openshift cli env rc \-\-all ENV=prod - + # Import environment from a secret openshift cli env \-\-from=secret/mysecret dc/myapp - + # Import environment from a config map with a prefix openshift cli env \-\-from=configmap/myconfigmap \-\-prefix=MYSQL\_ dc/myapp - + # Remove the environment variable ENV from container 'c1' in all deployment configs openshift cli env dc \-\-all \-\-containers="c1" ENV\- - + # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server openshift cli env \-f dc.json ENV\- - + # Set some of the local shell environment into a deployment config on the server env | grep RAILS\_ | openshift cli env \-e \- dc/registry diff --git a/docs/man/man1/openshift-cli-ex-dockerbuild.1 b/docs/man/man1/openshift-cli-ex-dockerbuild.1 index 1594f9c57395..5ceff4c06c85 100644 --- a/docs/man/man1/openshift-cli-ex-dockerbuild.1 +++ b/docs/man/man1/openshift-cli-ex-dockerbuild.1 @@ -16,10 +16,7 @@ openshift cli ex dockerbuild \- Perform a direct Docker build Build a Dockerfile into a single layer .PP -Builds the provided directory with a Dockerfile into a single layered image. -Requires that you have a working connection to a Docker engine. You may mount -secrets or config into the build with the \-\-mount flag \- these files will not -be included in the final image. +Builds the provided directory with a Dockerfile into a single layered image.Requires that you have a working connection to a Docker engine. You may mountsecrets or config into the build with the \-\-mount flag \- these files will notbe included in the final image. .PP Experimental: This command is under active development and may change without notice. @@ -112,7 +109,7 @@ Experimental: This command is under active development and may change without no .nf # Build the current directory into a single layer and tag openshift cli ex dockerbuild . myimage:latest - + # Mount a client secret into the build at a certain path openshift cli ex dockerbuild . myimage:latest \-\-mount \~/mysecret.pem:/etc/pki/secret/mysecret.pem diff --git a/docs/man/man1/openshift-cli-exec.1 b/docs/man/man1/openshift-cli-exec.1 index 3721dfc9ee50..06bb123ae596 100644 --- a/docs/man/man1/openshift-cli-exec.1 +++ b/docs/man/man1/openshift-cli-exec.1 @@ -107,7 +107,7 @@ Execute a command in a container .nf # Get output from running 'date' in ruby\-container from pod 'mypod' openshift cli exec mypod \-c ruby\-container date - + # Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 'mypod' and sends stdout/stderr from 'bash' back to the client openshift cli exec mypod \-c ruby\-container \-i \-t \-\- bash \-il diff --git a/docs/man/man1/openshift-cli-explain.1 b/docs/man/man1/openshift-cli-explain.1 index effd695d69a2..8fabe71e4cd2 100644 --- a/docs/man/man1/openshift-cli-explain.1 +++ b/docs/man/man1/openshift-cli-explain.1 @@ -16,10 +16,7 @@ openshift cli explain \- Documentation of resources Documentation of resources. .PP -Possible resource types include: pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -resourcequotas (quota), namespaces (ns) or endpoints (ep). +Possible resource types include: pods (po), services (svc),replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),resourcequotas (quota), namespaces (ns) or endpoints (ep). .SH OPTIONS @@ -103,11 +100,11 @@ resourcequotas (quota), namespaces (ns) or endpoints (ep). .RS .nf -# Get the documentation of the resource and its fields -openshift cli explain pods - -# Get the documentation of a specific field of a resource -openshift cli explain pods.spec.containers + # Get the documentation of the resource and its fields + openshift cli explain pods + + # Get the documentation of a specific field of a resource + openshift cli explain pods.spec.containers .fi .RE diff --git a/docs/man/man1/openshift-cli-export.1 b/docs/man/man1/openshift-cli-export.1 index 58233cbce3f9..6207be73cd35 100644 --- a/docs/man/man1/openshift-cli-export.1 +++ b/docs/man/man1/openshift-cli-export.1 @@ -16,21 +16,13 @@ openshift cli export \- Export resources so they can be used elsewhere Export resources so they can be used elsewhere .PP -The export command makes it easy to take existing objects and convert them to configuration files -for backups or for creating elsewhere in the cluster. Fields that cannot be specified on create -will be set to empty, and any field which is assigned on creation (like a service's clusterIP, or -a deployment config's latestVersion). The status part of objects is also cleared. +The export command makes it easy to take existing objects and convert them to configuration filesfor backups or for creating elsewhere in the cluster. Fields that cannot be specified on createwill be set to empty, and any field which is assigned on creation (like a service's clusterIP, ora deployment config's latestVersion). The status part of objects is also cleared. .PP -Some fields like clusterIP may be useful when exporting an application from one cluster to apply -to another \- assuming another service on the destination cluster does not already use that IP. -The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use -\-\-raw to get the exact values for an object \- useful for converting a file on disk between API -versions. +Some fields like clusterIP may be useful when exporting an application from one cluster to applyto another \- assuming another service on the destination cluster does not already use that IP.The \-\-exact flag will instruct export to not clear fields that might be useful. You may also use\-\-raw to get the exact values for an object \- useful for converting a file on disk between APIversions. .PP -Another use case for export is to create reusable templates for applications. Pass \-\-as\-template -to generate the API structure for a template to which you can add parameters and object labels. +Another use case for export is to create reusable templates for applications. Pass \-\-as\-templateto generate the API structure for a template to which you can add parameters and object labels. .SH OPTIONS @@ -168,10 +160,10 @@ to generate the API structure for a template to which you can add parameters and .nf # export the services and deployment configurations labeled name=test openshift cli export svc,dc \-l name=test - + # export all services to a template openshift cli export service \-\-as\-template=test - + # export to JSON openshift cli export service \-o json diff --git a/docs/man/man1/openshift-cli-expose.1 b/docs/man/man1/openshift-cli-expose.1 index 359ea175eee7..a8af6144d862 100644 --- a/docs/man/man1/openshift-cli-expose.1 +++ b/docs/man/man1/openshift-cli-expose.1 @@ -16,9 +16,7 @@ openshift cli expose \- Expose a replicated application as a service or route Expose containers internally as services or externally via routes .PP -There is also the ability to expose a deployment configuration, replication controller, service, or pod -as a new service on a specified port. If no labels are specified, the new object will re\-use the -labels from the object it exposes. +There is also the ability to expose a deployment configuration, replication controller, service, or podas a new service on a specified port. If no labels are specified, the new object will re\-use thelabels from the object it exposes. .SH OPTIONS @@ -216,16 +214,16 @@ labels from the object it exposes. .nf # Create a route based on service nginx. The new route will re\-use nginx's labels openshift cli expose service nginx - + # Create a route and specify your own label and route name openshift cli expose service nginx \-l name=myroute \-\-name=fromdowntown - + # Create a route and specify a hostname openshift cli expose service nginx \-\-hostname=www.example.com - + # Expose a deployment configuration as a service and use the specified port openshift cli expose dc ruby\-hello\-world \-\-port=8080 - + # Expose a service as a route in the specified path openshift cli expose service nginx \-\-path=/nginx diff --git a/docs/man/man1/openshift-cli-extract.1 b/docs/man/man1/openshift-cli-extract.1 index 35dbab2709c8..eede33a32fe8 100644 --- a/docs/man/man1/openshift-cli-extract.1 +++ b/docs/man/man1/openshift-cli-extract.1 @@ -16,13 +16,10 @@ openshift cli extract \- Extract secrets or config maps to disk Extract files out of secrets and config maps .PP -The extract command makes it easy to download the contents of a config map or secret into a directory. -Each key in the config map or secret is created as a separate file with the name of the key, as it -is when you mount a secret or config map into a container. +The extract command makes it easy to download the contents of a config map or secret into a directory.Each key in the config map or secret is created as a separate file with the name of the key, as itis when you mount a secret or config map into a container. .PP -You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract to -with \-\-to=DIRECTORY. +You can limit which keys are extracted with the \-\-keys=NAME flag, or set the directory to extract towith \-\-to=DIRECTORY. .SH OPTIONS @@ -148,10 +145,10 @@ with \-\-to=DIRECTORY. .nf # extract the secret "test" to the current directory openshift cli extract secret/test - + # extract the config map "nginx" to the /tmp directory openshift cli extract configmap/nginx \-\-to=/tmp - + # extract only the key "nginx.conf" from config map "nginx" to the /tmp directory openshift cli extract configmap/nginx \-\-to=/tmp \-\-keys=nginx.conf diff --git a/docs/man/man1/openshift-cli-get.1 b/docs/man/man1/openshift-cli-get.1 index b87eb281299a..163b7fe61439 100644 --- a/docs/man/man1/openshift-cli-get.1 +++ b/docs/man/man1/openshift-cli-get.1 @@ -16,10 +16,7 @@ openshift cli get \- Display one or many resources Display one or many resources .PP -Possible resources include builds, buildConfigs, services, pods, etc. To see a -list of common resources, use 'openshift cli get'. Some resources may omit -advanced details that you can see with '\-o wide'. If you want an even more -detailed view, use 'openshift cli describe'. +Possible resources include builds, buildConfigs, services, pods, etc. To seea list of common resources, use 'openshift cli get'. Some resources may omit advanceddetails that you can see with '\-o wide'. If you want an even more detailedview, use 'openshift cli describe'. .SH OPTIONS @@ -173,16 +170,16 @@ detailed view, use 'openshift cli describe'. .nf # List all pods in ps output format. openshift cli get pods - + # List a single replication controller with specified ID in ps output format. openshift cli get rc redis - + # List all pods and show more details about them. openshift cli get \-o wide pods - + # List a single pod in JSON output format. openshift cli get \-o json pod redis\-pod - + # Return only the status value of the specified pod. openshift cli get \-o template pod redis\-pod \-\-template={{.currentState.status}} diff --git a/docs/man/man1/openshift-cli-idle.1 b/docs/man/man1/openshift-cli-idle.1 index a391b423d620..a2039d8b7d22 100644 --- a/docs/man/man1/openshift-cli-idle.1 +++ b/docs/man/man1/openshift-cli-idle.1 @@ -13,17 +13,13 @@ openshift cli idle \- Idle scalable resources .SH DESCRIPTION .PP -Idle scalable resources. +Idle scalable resources .PP -Idling discovers the scalable resources (such as deployment configs and replication controllers) -associated with a series of services by examining the endpoints of the service. -Each service is then marked as idled, the associated resources are recorded, and the resources -are scaled down to zero replicas. +Idling discovers the scalable resources (such as deployment configs and replication controllers)associated with a series of services by examining the endpoints of the service.Each service is then marked as idled, the associated resources are recorded, and the resourcesare scaled down to zero replicas. .PP -Upon receiving network traffic, the services (and any associated routes) will "wake up" the -associated resources by scaling them back up to their previous scale. +Upon receiving network traffic, the services (and any associated routes) will "wake up" theassociated resources by scaling them back up to their previous scale. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-import-app.json.1 b/docs/man/man1/openshift-cli-import-app.json.1 index a3314224a51d..34de4c92ef6f 100644 --- a/docs/man/man1/openshift-cli-import-app.json.1 +++ b/docs/man/man1/openshift-cli-import-app.json.1 @@ -16,14 +16,10 @@ openshift cli import app.json \- Import an app.json definition into OpenShift (e Import app.json files as OpenShift objects .PP -app.json defines the pattern of a simple, stateless web application that can be horizontally scaled. -This command will transform a provided app.json object into its OpenShift equivalent. -During transformation fields in the app.json syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +app.json defines the pattern of a simple, stateless web application that can be horizontally scaled.This command will transform a provided app.json object into its OpenShift equivalent.During transformation fields in the app.json syntax that are not relevant when running on top ofa containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate aconfiguration file for later use. .PP Experimental: This command is under active development and may change without notice. @@ -132,11 +128,10 @@ Experimental: This command is under active development and may change without no .nf # Import a directory containing an app.json file $ openshift cli import app.json \-f . - + # Turn an app.json file into a template $ openshift cli import app.json \-f ./app.json \-o yaml \-\-as\-template - .fi .RE diff --git a/docs/man/man1/openshift-cli-import-docker-compose.1 b/docs/man/man1/openshift-cli-import-docker-compose.1 index 1da367bf24a6..f31535c9c015 100644 --- a/docs/man/man1/openshift-cli-import-docker-compose.1 +++ b/docs/man/man1/openshift-cli-import-docker-compose.1 @@ -16,14 +16,10 @@ openshift cli import docker\-compose \- Import a docker\-compose.yml project int Import a Docker Compose file as OpenShift objects .PP -Docker Compose files offer a container centric build and deploy pattern for simple applications. -This command will transform a provided docker\-compose.yml application into its OpenShift equivalent. -During transformation fields in the compose syntax that are not relevant when running on top of -a containerized platform will be ignored and a warning printed. +Docker Compose files offer a container centric build and deploy pattern for simple applications.This command will transform a provided docker\-compose.yml application into its OpenShift equivalent.During transformation fields in the compose syntax that are not relevant when running on top ofa containerized platform will be ignored and a warning printed. .PP -The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate a -configuration file for later use. +The command will create objects unless you pass the \-o yaml or \-\-as\-template flags to generate aconfiguration file for later use. .PP Experimental: This command is under active development and may change without notice. @@ -128,11 +124,10 @@ Experimental: This command is under active development and may change without no .nf # Import a docker\-compose.yml file into OpenShift openshift cli import docker\-compose \-f ./docker\-compose.yml - - # Turn a docker\-compose.yml file into a template + + # Turn a docker\-compose.yml file into a template openshift cli import docker\-compose \-f ./docker\-compose.yml \-o yaml \-\-as\-template - .fi .RE diff --git a/docs/man/man1/openshift-cli-import-image.1 b/docs/man/man1/openshift-cli-import-image.1 index 8f584ecf6a99..49b431536c15 100644 --- a/docs/man/man1/openshift-cli-import-image.1 +++ b/docs/man/man1/openshift-cli-import-image.1 @@ -16,8 +16,7 @@ openshift cli import\-image \- Imports images from a Docker registry Import tag and image information from an external Docker image repository .PP -Only image streams that have a value set for spec.dockerImageRepository and/or -spec.Tags may have tag and image information imported. +Only image streams that have a value set for spec.dockerImageRepository and/orspec.Tags may have tag and image information imported. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-label.1 b/docs/man/man1/openshift-cli-label.1 index 1d775856a41a..b432ad09d799 100644 --- a/docs/man/man1/openshift-cli-label.1 +++ b/docs/man/man1/openshift-cli-label.1 @@ -16,11 +16,7 @@ openshift cli label \- Update the labels on a resource Update the labels on one or more resources .PP -A valid label value is consisted of letters and/or numbers with a max length of 63 -characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwise -attempting to overwrite a label will result in an error. If \-\-resource\-version is -specified, then updates will use this resource version, otherwise the existing -resource\-version will be used. +A valid label value is consisted of letters and/or numbers with a max length of 63characters. If \-\-overwrite is true, then existing labels can be overwritten, otherwiseattempting to overwrite a label will result in an error. If \-\-resource\-version isspecified, then updates will use this resource version, otherwise the existingresource\-version will be used. .SH OPTIONS @@ -166,16 +162,16 @@ resource\-version will be used. .nf # Update pod 'foo' with the label 'unhealthy' and the value 'true'. openshift cli label pods foo unhealthy=true - + # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. openshift cli label \-\-overwrite pods foo status=unhealthy - + # Update all pods in the namespace openshift cli label pods \-\-all status=unhealthy - + # Update pod 'foo' only if the resource is unchanged from version 1. openshift cli label pods foo status=unhealthy \-\-resource\-version=1 - + # Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the \-\-overwrite flag. openshift cli label pods foo bar\- diff --git a/docs/man/man1/openshift-cli-login.1 b/docs/man/man1/openshift-cli-login.1 index b50acfcd638d..8d014d4df3be 100644 --- a/docs/man/man1/openshift-cli-login.1 +++ b/docs/man/man1/openshift-cli-login.1 @@ -16,15 +16,10 @@ openshift cli login \- Log in to a server Log in to your server and save login for subsequent use .PP -First\-time users of the client should run this command to connect to a server, -establish an authenticated session, and save connection to the configuration file. The -default configuration will be saved to your home directory under -".kube/config". +First\-time users of the client should run this command to connect to a server,establish an authenticated session, and save connection to the configuration file. Thedefault configuration will be saved to your home directory under".kube/config". .PP -The information required to login \-\- like username and password, a session token, or -the server details \-\- can be provided through flags. If not provided, the command will -prompt for user input as needed. +The information required to login \-\- like username and password, a session token, orthe server details \-\- can be provided through flags. If not provided, the command willprompt for user input as needed. .SH OPTIONS @@ -110,10 +105,10 @@ prompt for user input as needed. .nf # Log in interactively openshift cli login - + # Log in to the given server with the given certificate authority file openshift cli login localhost:8443 \-\-certificate\-authority=/path/to/cert.crt - + # Log in to the given server with the given credentials (will not prompt interactively) openshift cli login localhost:8443 \-\-username=myuser \-\-password=mypass diff --git a/docs/man/man1/openshift-cli-logout.1 b/docs/man/man1/openshift-cli-logout.1 index 3983bebf59f4..6fcaae37597e 100644 --- a/docs/man/man1/openshift-cli-logout.1 +++ b/docs/man/man1/openshift-cli-logout.1 @@ -16,14 +16,10 @@ openshift cli logout \- End the current server session Log out of the active session out by clearing saved tokens .PP -An authentication token is stored in the config file after login \- this command will delete -that token on the server, and then remove the token from the configuration file. +An authentication token is stored in the config file after login \- this command will deletethat token on the server, and then remove the token from the configuration file. .PP -If you are using an alternative authentication method like Kerberos or client certificates, -your ticket or client certificate will not be removed from the current system since these -are typically managed by other programs. Instead, you can delete your config file to remove -the local copy of that certificate or the record of your server login. +If you are using an alternative authentication method like Kerberos or client certificates,your ticket or client certificate will not be removed from the current system since theseare typically managed by other programs. Instead, you can delete your config file to removethe local copy of that certificate or the record of your server login. .PP After logging out, if you want to log back into the server use 'openshift cli login'. @@ -100,7 +96,6 @@ After logging out, if you want to log back into the server use 'openshift cli lo .RS .nf - # Logout openshift cli logout diff --git a/docs/man/man1/openshift-cli-logs.1 b/docs/man/man1/openshift-cli-logs.1 index f52da96728db..6a3e1baccde0 100644 --- a/docs/man/man1/openshift-cli-logs.1 +++ b/docs/man/man1/openshift-cli-logs.1 @@ -13,17 +13,13 @@ openshift cli logs \- Print the logs for a resource. .SH DESCRIPTION .PP -Print the logs for a resource. +Print the logs for a resource .PP -Supported resources are builds, build configs (bc), deployment configs (dc), and pods. -When a pod is specified and has more than one container, the container name should be -specified via \-c. When a build config or deployment config is specified, you can view -the logs for a particular version of it via \-\-version. +Supported resources are builds, build configs (bc), deployment configs (dc), and pods.When a pod is specified and has more than one container, the container name should bespecified via \-c. When a build config or deployment config is specified, you can viewthe logs for a particular version of it via \-\-version. .PP -If your pod is failing to start, you may need to use the \-\-previous option to see the -logs of the last attempt. +If your pod is failing to start, you may need to use the \-\-previous option to see thelogs of the last attempt. .SH OPTIONS @@ -145,18 +141,18 @@ logs of the last attempt. .nf # Start streaming the logs of the most recent build of the openldap build config. openshift cli logs \-f bc/openldap - + # Start streaming the logs of the latest deployment of the mysql deployment config. openshift cli logs \-f dc/mysql - + # Get the logs of the first deployment for the mysql deployment config. Note that logs # from older deployments may not exist either because the deployment was successful # or due to deployment pruning or manual deletion of the deployment. openshift cli logs \-\-version=1 dc/mysql - + # Return a snapshot of ruby\-container logs from pod backend. openshift cli logs backend \-c ruby\-container - + # Start streaming of ruby\-container logs from pod backend. openshift cli logs \-f pod/backend \-c ruby\-container diff --git a/docs/man/man1/openshift-cli-new-app.1 b/docs/man/man1/openshift-cli-new-app.1 index 50201ad1fdd6..67419f4b1d35 100644 --- a/docs/man/man1/openshift-cli-new-app.1 +++ b/docs/man/man1/openshift-cli-new-app.1 @@ -16,21 +16,13 @@ openshift cli new\-app \- Create a new application Create a new application by specifying source code, templates, and/or images .PP -This command will try to build up the components of an application using images, templates, -or code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, an integrated image stream, or stored templates. +This command will try to build up the components of an application using images, templates,or code that has a public repository. It will lookup the images on the local Docker installation(if available), a Docker registry, an integrated image stream, or stored templates. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. The images will be deployed via a deployment -configuration, and a service will be connected to the first public port of the app. You may either specify -components using the various existing flags or let new\-app autodetect what kind of components -you have provided. +If you specify a source code URL, it will set up a build that takes your source code and convertsit into an image that can run inside of a pod. Local source must be in a git repository that has aremote repository that the server can see. The images will be deployed via a deploymentconfiguration, and a service will be connected to the first public port of the app. You may either specifycomponents using the various existing flags or let new\-app autodetect what kind of componentsyou have provided. .PP -If you provide source code, a new build will be automatically triggered. -You can use 'openshift cli status' to check the progress. +If you provide source code, a new build will be automatically triggered.You can use 'openshift cli status' to check the progress. .SH OPTIONS @@ -202,42 +194,41 @@ You can use 'openshift cli status' to check the progress. .RS .nf - # List all local templates and image streams that can be used to create an app openshift cli new\-app \-\-list - + # Create an application based on the source code in the current git repository (with a public remote) # and a Docker image openshift cli new\-app . \-\-docker\-image=repo/langimage - + # Create a Ruby application based on the provided [image]\~[source code] combination openshift cli new\-app centos/ruby\-22\-centos7\~https://github.com/openshift/ruby\-ex.git - + # Use the public Docker Hub MySQL image to create an app. Generated artifacts will be labeled with db=mysql openshift cli new\-app mysql MYSQL\_USER=user MYSQL\_PASSWORD=pass MYSQL\_DATABASE=testdb \-l db=mysql - + # Use a MySQL image in a private registry to create an app and override application artifacts' names openshift cli new\-app \-\-docker\-image=myregistry.com/mycompany/mysql \-\-name=private - + # Create an application from a remote repository using its beta4 branch openshift cli new\-app https://github.com/openshift/ruby\-hello\-world#beta4 - + # Create an application based on a stored template, explicitly setting a parameter value openshift cli new\-app \-\-template=ruby\-helloworld\-sample \-\-param=MYSQL\_USER=admin - + # Create an application from a remote repository and specify a context directory openshift cli new\-app https://github.com/youruser/yourgitrepo \-\-context\-dir=src/build - + # Create an application based on a template file, explicitly setting a parameter value openshift cli new\-app \-\-file=./example/myapp/template.json \-\-param=MYSQL\_USER=admin - + # Search all templates, image streams, and Docker images for the ones that match "ruby" openshift cli new\-app \-\-search ruby - + # Search for "ruby", but only in stored templates (\-\-template, \-\-image\-stream and \-\-docker\-image # can be used to filter search results) openshift cli new\-app \-\-search \-\-template=ruby - + # Search for "ruby" in stored templates and print the output as an YAML openshift cli new\-app \-\-search \-\-template=ruby \-\-output=yaml diff --git a/docs/man/man1/openshift-cli-new-build.1 b/docs/man/man1/openshift-cli-new-build.1 index 6d4ea18a10cb..8c499d485c6e 100644 --- a/docs/man/man1/openshift-cli-new-build.1 +++ b/docs/man/man1/openshift-cli-new-build.1 @@ -16,18 +16,13 @@ openshift cli new\-build \- Create a new build configuration Create a new build by specifying source code .PP -This command will try to create a build configuration for your application using images and -code that has a public repository. It will lookup the images on the local Docker installation -(if available), a Docker registry, or an image stream. +This command will try to create a build configuration for your application using images andcode that has a public repository. It will lookup the images on the local Docker installation(if available), a Docker registry, or an image stream. .PP -If you specify a source code URL, it will set up a build that takes your source code and converts -it into an image that can run inside of a pod. Local source must be in a git repository that has a -remote repository that the server can see. +If you specify a source code URL, it will set up a build that takes your source code and convertsit into an image that can run inside of a pod. Local source must be in a git repository that has aremote repository that the server can see. .PP -Once the build configuration is created a new build will be automatically triggered. -You can use 'openshift cli status' to check the progress. +Once the build configuration is created a new build will be automatically triggered.You can use 'openshift cli status' to check the progress. .SH OPTIONS @@ -191,26 +186,25 @@ You can use 'openshift cli status' to check the progress. .RS .nf - # Create a build config based on the source code in the current git repository (with a public # remote) and a Docker image openshift cli new\-build . \-\-docker\-image=repo/langimage - + # Create a NodeJS build config based on the provided [image]\~[source code] combination openshift cli new\-build openshift/nodejs\-010\-centos7\~https://github.com/openshift/nodejs\-ex.git - + # Create a build config from a remote repository using its beta2 branch openshift cli new\-build https://github.com/openshift/ruby\-hello\-world#beta2 - + # Create a build config using a Dockerfile specified as an argument openshift cli new\-build \-D $'FROM centos:7\\nRUN yum install \-y httpd' - + # Create a build config from a remote repository and add custom environment variables openshift cli new\-build https://github.com/openshift/ruby\-hello\-world RACK\_ENV=development - + # Create a build config from a remote repository and inject the npmrc into a build openshift cli new\-build https://github.com/openshift/ruby\-hello\-world \-\-build\-secret npmrc:.npmrc - + # Create a build config that gets its input from a remote repository and another Docker image openshift cli new\-build https://github.com/openshift/ruby\-hello\-world \-\-source\-image=openshift/jenkins\-1\-centos7 \-\-source\-image\-path=/var/lib/jenkins:tmp diff --git a/docs/man/man1/openshift-cli-new-project.1 b/docs/man/man1/openshift-cli-new-project.1 index 6ae69945d746..192fb9b5bbca 100644 --- a/docs/man/man1/openshift-cli-new-project.1 +++ b/docs/man/man1/openshift-cli-new-project.1 @@ -16,8 +16,7 @@ openshift cli new\-project \- Request a new project Create a new project for yourself .PP -If your administrator allows self\-service, this command will create a new project for you and assign you -as the project admin. +If your administrator allows self\-service, this command will create a new project for you and assign youas the project admin. .PP After your project is created it will become the default project in your config. @@ -110,7 +109,7 @@ After your project is created it will become the default project in your config. .nf # Create a new project with minimal information openshift cli new\-project web\-team\-dev - + # Create a new project with a display name and description openshift cli new\-project web\-team\-dev \-\-display\-name="Web Team Development" \-\-description="Development project for the web team." diff --git a/docs/man/man1/openshift-cli-observe.1 b/docs/man/man1/openshift-cli-observe.1 index 8078cccae0aa..0fdfec7cd00d 100644 --- a/docs/man/man1/openshift-cli-observe.1 +++ b/docs/man/man1/openshift-cli-observe.1 @@ -16,16 +16,10 @@ openshift cli observe \- Observe changes to resources and react to them (experim Observe changes to resources and take action on them .PP -This command assists in building scripted reactions to changes that occur in -Kubernetes or OpenShift resources. This is frequently referred to as a -'controller' in Kubernetes and acts to ensure particular conditions are -maintained. On startup, observe will list all of the resources of a -particular type and execute the provided script on each one. Observe watches -the server for changes, and will reexecute the script for each update. +This command assists in building scripted reactions to changes that occur inKubernetes or OpenShift resources. This is frequently referred to as a'controller' in Kubernetes and acts to ensure particular conditions aremaintained. On startup, observe will list all of the resources of aparticular type and execute the provided script on each one. Observe watchesthe server for changes, and will reexecute the script for each update. .PP -Observe works best for problems of the form "for every resource X, make sure -Y is true". Some examples of ways observe can be used include: +Observe works best for problems of the form "for every resource X, make sureY is true". Some examples of ways observe can be used include: .IP .IP @@ -41,11 +35,7 @@ Y is true". Some examples of ways observe can be used include: .IP \(bu Delete pods that have reached successful completion after a period of time. .PP -The simplest pattern is maintaining an invariant on an object \- for instance, -"every namespace should have an annotation that indicates its owner". If the -object is deleted no reaction is necessary. A variation on that pattern is -creating another object: "every namespace should have a quota object based -on the resources allowed for an owner". +The simplest pattern is maintaining an invariant on an object \- for instance,"every namespace should have an annotation that indicates its owner". If theobject is deleted no reaction is necessary. A variation on that pattern iscreating another object: "every namespace should have a quota object basedon the resources allowed for an owner". .PP $ cat set\_owner.sh @@ -58,23 +48,13 @@ $ cat set\_owner.sh $ openshift cli observe namespaces \-\- ./set\_owner.sh .PP -The set\_owner.sh script is invoked with a single argument (the namespace name) -for each namespace. This simple script ensures that any user without the -"owner" annotation gets one set, but preserves any existing value. +The set\_owner.sh script is invoked with a single argument (the namespace name)for each namespace. This simple script ensures that any user without the"owner" annotation gets one set, but preserves any existing value. .PP -The next common of controller pattern is provisioning \- making changes in an -external system to match the state of a Kubernetes resource. These scripts need -to account for deletions that may take place while the observe command is not -running. You can provide the list of known objects via the \-\-names command, -which should return a newline\-delimited list of names or namespace/name pairs. -Your command will be invoked whenever observe checks the latest state on the -server \- any resources returned by \-\-names that are not found on the server -will be passed to your \-\-delete command. +The next common of controller pattern is provisioning \- making changes in anexternal system to match the state of a Kubernetes resource. These scripts needto account for deletions that may take place while the observe command is notrunning. You can provide the list of known objects via the \-\-names command,which should return a newline\-delimited list of names or namespace/name pairs.Your command will be invoked whenever observe checks the latest state on theserver \- any resources returned by \-\-names that are not found on the serverwill be passed to your \-\-delete command. .PP -For example, you may wish to ensure that every node that is added to Kubernetes -is added to your cluster inventory along with its IP: +For example, you may wish to ensure that every node that is added to Kubernetesis added to your cluster inventory along with its IP: .PP $ cat add\_to\_inventory.sh @@ -96,27 +76,18 @@ $ cat known\_nodes.sh .PP $ openshift cli observe nodes \-a '{ .status.addresses[0].address }' \\ - \-\-names ./known\_nodes.sh \\ - \-\-delete ./remove\_from\_inventory.sh \\ - \-\- ./add\_to\_inventory.sh + \-\-names ./known\_nodes.sh \\ + \-\-delete ./remove\_from\_inventory.sh \\ + \-\- ./add\_to\_inventory.sh .PP -If you stop the observe command and then delete a node, when you launch observe -again the contents of inventory will be compared to the list of nodes from the -server, and any node in the inventory file that no longer exists will trigger -a call to remove\_from\_inventory.sh with the name of the node. +If you stop the observe command and then delete a node, when you launch observeagain the contents of inventory will be compared to the list of nodes from theserver, and any node in the inventory file that no longer exists will triggera call to removefrominventory.sh with the name of the node. .PP -Important: when handling deletes, the previous state of the object may not be - available and only the name/namespace of the object will be passed to your - \-\-delete command as arguments (all custom arguments are omitted). +Important: when handling deletes, the previous state of the object may not beavailable and only the name/namespace of the object will be passed to your\-\-delete command as arguments (all custom arguments are omitted). .PP -More complicated interactions build on the two examples above \- your inventory -script could make a call to allocate storage on your infrastructure as a -service, or register node names in DNS, or set complex firewalls. The more -complex your integration, the more important it is to record enough data in the -remote system that you can identify when resources on either side are deleted. +More complicated interactions build on the two examples above \- your inventoryscript could make a call to allocate storage on your infrastructure as aservice, or register node names in DNS, or set complex firewalls. The morecomplex your integration, the more important it is to record enough data in theremote system that you can identify when resources on either side are deleted. .PP Experimental: This command is under active development and may change without notice. @@ -263,12 +234,11 @@ Experimental: This command is under active development and may change without no .RS .nf - # observe changes to services - openshift cli observe services - - # observe changes to services, including the clusterIP and invoke a script for each - openshift cli observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh - + # Observe changes to services + openshift cli observe services + + # Observe changes to services, including the clusterIP and invoke a script for each + openshift cli observe services \-a '{ .spec.clusterIP }' \-\- register\_dns.sh .fi .RE diff --git a/docs/man/man1/openshift-cli-policy-add-role-to-user.1 b/docs/man/man1/openshift-cli-policy-add-role-to-user.1 index 717a6f3b552f..90fc42d27dd8 100644 --- a/docs/man/man1/openshift-cli-policy-add-role-to-user.1 +++ b/docs/man/man1/openshift-cli-policy-add-role-to-user.1 @@ -99,7 +99,7 @@ Add a role to users or serviceaccounts for the current project .nf # Add the 'view' role to user1 for the current project openshift cli policy add\-role\-to\-user view user1 - + # Add the 'edit' role to serviceaccount1 for the current project openshift cli policy add\-role\-to\-user edit \-z serviceaccount1 diff --git a/docs/man/man1/openshift-cli-port-forward.1 b/docs/man/man1/openshift-cli-port-forward.1 index 3bfb9e1c0520..fa2365251d73 100644 --- a/docs/man/man1/openshift-cli-port-forward.1 +++ b/docs/man/man1/openshift-cli-port-forward.1 @@ -95,13 +95,13 @@ Forward 1 or more local ports to a pod .nf # Listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod openshift cli port\-forward mypod 5000 6000 - + # Listens on port 8888 locally, forwarding to 5000 in the pod openshift cli port\-forward mypod 8888:5000 - + # Listens on a random port locally, forwarding to 5000 in the pod openshift cli port\-forward mypod :5000 - + # Listens on a random port locally, forwarding to 5000 in the pod openshift cli port\-forward mypod 0:5000 diff --git a/docs/man/man1/openshift-cli-process.1 b/docs/man/man1/openshift-cli-process.1 index 25839168c0f0..51bbcff5ecab 100644 --- a/docs/man/man1/openshift-cli-process.1 +++ b/docs/man/man1/openshift-cli-process.1 @@ -16,13 +16,10 @@ openshift cli process \- Process a template into list of resources Process template into a list of resources specified in filename or stdin .PP -Templates allow parameterization of resources prior to being sent to the server for creation or -update. Templates have "parameters", which may either be generated on creation or set by the user, -as well as metadata describing the template. +Templates allow parameterization of resources prior to being sent to the server for creation orupdate. Templates have "parameters", which may either be generated on creation or set by the user,as well as metadata describing the template. .PP -The output of the process command is always a list of one or more resources. You may pipe the -output to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. +The output of the process command is always a list of one or more resources. You may pipe theoutput to the create command over STDIN (using the '\-f \-' option) or redirect it to a file. .SH OPTIONS @@ -133,19 +130,19 @@ output to the create command over STDIN (using the '\-f \-' option) or redirect .nf # Convert template.json file into resource list and pass to create openshift cli process \-f template.json | openshift cli create \-f \- - + # Process template while passing a user\-defined label openshift cli process \-f template.json \-l name=mytemplate - + # Convert stored template into resource list openshift cli process foo - + # Convert stored template into resource list by setting/overriding parameter values openshift cli process foo PARM1=VALUE1 PARM2=VALUE2 - + # Convert template stored in different namespace into a resource list openshift cli process openshift//foo - + # Convert template.json into resource list cat template.json | openshift cli process \-f \- diff --git a/docs/man/man1/openshift-cli-project.1 b/docs/man/man1/openshift-cli-project.1 index 00163e9a0683..d7a63d521f25 100644 --- a/docs/man/man1/openshift-cli-project.1 +++ b/docs/man/man1/openshift-cli-project.1 @@ -16,16 +16,10 @@ openshift cli project \- Switch to another project Switch to another project and make it the default in your configuration .PP -If no project was specified on the command line, display information about the current active -project. Since you can use this command to connect to projects on different servers, you will -occasionally encounter projects of the same name on different servers. When switching to that -project, a new local context will be created that will have a unique name \- for instance, -'myapp\-2'. If you have previously created a context with a different name than the project -name, this command will accept that context name instead. +If no project was specified on the command line, display information about the current activeproject. Since you can use this command to connect to projects on different servers, you willoccasionally encounter projects of the same name on different servers. When switching to thatproject, a new local context will be created that will have a unique name \- for instance,'myapp\-2'. If you have previously created a context with a different name than the projectname, this command will accept that context name instead. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config'command. .SH OPTIONS @@ -107,7 +101,7 @@ command. .nf # Switch to 'myapp' project openshift cli project myapp - + # Display the project currently in use openshift cli project diff --git a/docs/man/man1/openshift-cli-projects.1 b/docs/man/man1/openshift-cli-projects.1 index 6689098be29b..f70986c4e648 100644 --- a/docs/man/man1/openshift-cli-projects.1 +++ b/docs/man/man1/openshift-cli-projects.1 @@ -16,8 +16,7 @@ openshift cli projects \- Display existing projects Display information about the current active project and existing projects on the server. .PP -For advanced configuration, or to manage the contents of your config file, use the 'config' -command. +For advanced configuration, or to manage the contents of your config file, use the 'config'command. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-proxy.1 b/docs/man/man1/openshift-cli-proxy.1 index 06e39ade4038..c7902487ea9a 100644 --- a/docs/man/man1/openshift-cli-proxy.1 +++ b/docs/man/man1/openshift-cli-proxy.1 @@ -135,11 +135,11 @@ Run a proxy to the API server .nf # Run a proxy to the api server on port 8011, serving static content from ./local/www/ openshift cli proxy \-\-port=8011 \-\-www=./local/www/ - + # Run a proxy to the api server on an arbitrary local port. # The chosen port for the server will be output to stdout. openshift cli proxy \-\-port=0 - + # Run a proxy to the api server, changing the api prefix to my\-api # This makes e.g. the pods api available at localhost:8011/my\-api/api/v1/pods/ openshift cli proxy \-\-api\-prefix=/my\-api diff --git a/docs/man/man1/openshift-cli-replace.1 b/docs/man/man1/openshift-cli-replace.1 index 9e18ff7c3a18..bc1eeefcf768 100644 --- a/docs/man/man1/openshift-cli-replace.1 +++ b/docs/man/man1/openshift-cli-replace.1 @@ -142,10 +142,10 @@ JSON and YAML formats are accepted. .nf # Replace a pod using the data in pod.json. openshift cli replace \-f pod.json - + # Replace a pod based on the JSON passed into stdin. cat pod.json | openshift cli replace \-f \- - + # Force replace, delete and then re\-create the resource openshift cli replace \-\-force \-f pod.json diff --git a/docs/man/man1/openshift-cli-rollback.1 b/docs/man/man1/openshift-cli-rollback.1 index 9f0d6b2667bf..ed174d140f98 100644 --- a/docs/man/man1/openshift-cli-rollback.1 +++ b/docs/man/man1/openshift-cli-rollback.1 @@ -16,24 +16,13 @@ openshift cli rollback \- Revert part of an application back to a previous deplo Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated tomatch a previous deployment. By default only the pod and containerconfiguration will be changed and scaling or trigger settings will be left as\-is. Note that environment variables and volumes are included in rollbacks, soif you've recently updated security credentials in your environment yourprevious deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy' command. +Any image triggers present in the rolled back configuration will be disabledwith a warning. This is to help prevent your rolled back deployment from beingreplaced by a triggered deployment soon after your rollback. To re\-enable thetriggers, use the 'deploy' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to printa human\-readable representation of the updated deployment configuration instead ofexecuting the rollback. This is useful if you're not quite sure what the outcomewill be. .SH OPTIONS @@ -139,13 +128,13 @@ will be. .nf # Perform a rollback to the last successfully completed deployment for a deploymentconfig openshift cli rollback frontend - + # See what a rollback to version 3 will look like, but don't perform the rollback openshift cli rollback frontend \-\-to\-version=3 \-\-dry\-run - + # Perform a rollback to a specific deployment openshift cli rollback frontend\-2 - + # Perform the rollback manually by piping the JSON of the new config back to openshift cli openshift cli rollback frontend \-o json | openshift cli replace dc/frontend \-f \- diff --git a/docs/man/man1/openshift-cli-rollout-history.1 b/docs/man/man1/openshift-cli-rollout-history.1 index d39042476a58..07c5eb625bd0 100644 --- a/docs/man/man1/openshift-cli-rollout-history.1 +++ b/docs/man/man1/openshift-cli-rollout-history.1 @@ -16,8 +16,7 @@ openshift cli rollout history \- View rollout history View the history of rollouts for a specific deployment config .PP -You can also view more detailed information for a specific revision -by using the \-\-revision flag. +You can also view more detailed information for a specific revisionby using the \-\-revision flag. .SH OPTIONS @@ -107,7 +106,7 @@ by using the \-\-revision flag. .nf # View the rollout history of a deployment openshift cli rollout history dc/nginx - + # View the details of deployment revision 3 openshift cli rollout history dc/nginx \-\-revision=3 diff --git a/docs/man/man1/openshift-cli-rollout-pause.1 b/docs/man/man1/openshift-cli-rollout-pause.1 index 7b31206d4f0e..0b8ab504905e 100644 --- a/docs/man/man1/openshift-cli-rollout-pause.1 +++ b/docs/man/man1/openshift-cli-rollout-pause.1 @@ -16,8 +16,7 @@ openshift cli rollout pause \- Mark the provided resource as paused Mark the provided resource as paused .PP -Paused resources will not be reconciled by a controller. -Use \\"%[1]s rollout resume\\" to resume a paused resource. +Paused resources will not be reconciled by a controller.Use\\"%[1]s rollout resume\\" to resume a paused resource. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollout-resume.1 b/docs/man/man1/openshift-cli-rollout-resume.1 index cdcf9375e33c..a11dccc48c85 100644 --- a/docs/man/man1/openshift-cli-rollout-resume.1 +++ b/docs/man/man1/openshift-cli-rollout-resume.1 @@ -16,8 +16,7 @@ openshift cli rollout resume \- Resume a paused resource Resume a paused resource .PP -Paused resources will not be reconciled by a controller. By resuming a -resource, we allow it to be reconciled again. +Paused resources will not be reconciled by a controller. By resuming aresource, we allow it to be reconciled again. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli-rollout-undo.1 b/docs/man/man1/openshift-cli-rollout-undo.1 index 2516bb5018c8..a181e72ee63f 100644 --- a/docs/man/man1/openshift-cli-rollout-undo.1 +++ b/docs/man/man1/openshift-cli-rollout-undo.1 @@ -16,24 +16,13 @@ openshift cli rollout undo \- Undo a previous rollout Revert an application back to a previous deployment .PP -When you run this command your deployment configuration will be updated to -match a previous deployment. By default only the pod and container -configuration will be changed and scaling or trigger settings will be left as\- -is. Note that environment variables and volumes are included in rollbacks, so -if you've recently updated security credentials in your environment your -previous deployment may not have the correct values. +When you run this command your deployment configuration will be updated tomatch a previous deployment. By default only the pod and containerconfiguration will be changed and scaling or trigger settings will be left as\-is. Note that environment variables and volumes are included in rollbacks, soif you've recently updated security credentials in your environment yourprevious deployment may not have the correct values. .PP -Any image triggers present in the rolled back configuration will be disabled -with a warning. This is to help prevent your rolled back deployment from being -replaced by a triggered deployment soon after your rollback. To re\-enable the -triggers, use the 'deploy \-\-enable\-triggers' command. +Any image triggers present in the rolled back configuration will be disabledwith a warning. This is to help prevent your rolled back deployment from beingreplaced by a triggered deployment soon after your rollback. To re\-enable thetriggers, use the 'deploy \-\-enable\-triggers' command. .PP -If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to print -a human\-readable representation of the updated deployment configuration instead of -executing the rollback. This is useful if you're not quite sure what the outcome -will be. +If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to printa human\-readable representation of the updated deployment configuration instead ofexecuting the rollback. This is useful if you're not quite sure what the outcomewill be. .SH OPTIONS @@ -123,7 +112,7 @@ will be. .nf # Rollback to the previous deployment openshift cli rollout undo dc/nginx - + # Rollback to deployment revision 3. The replication controller for that version must exist. openshift cli rollout undo dc/nginx \-\-to\-revision=3 diff --git a/docs/man/man1/openshift-cli-rsh.1 b/docs/man/man1/openshift-cli-rsh.1 index 7f43c5aac5a1..732e1d370f6e 100644 --- a/docs/man/man1/openshift-cli-rsh.1 +++ b/docs/man/man1/openshift-cli-rsh.1 @@ -16,20 +16,10 @@ openshift cli rsh \- Start a shell session in a pod Open a remote shell session to a container .PP -This command will attempt to start a shell session in a pod for the specified resource. -It works with pods, deployment configs, jobs, daemon sets, and replication controllers. -Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. -It will default to the first container if none is specified, and will attempt to use -'/bin/sh' as the default shell. You may pass any flags supported by this command before -the resource name, and an optional command after the resource name, which will be executed -instead of a login shell. A TTY will be automatically allocated if standard input is -interactive \- use \-t and \-T to override. A TERM variable is sent to the environment where -the shell (or command) will be executed. By default its value is the same as the TERM -variable from the local environment; if not set, 'xterm' is used. +This command will attempt to start a shell session in a pod for the specified resource.It works with pods, deployment configs, jobs, daemon sets, and replication controllers.Any of the aforementioned resources (apart from pods) will be resolved to a ready pod.It will default to the first container if none is specified, and will attempt to use'/bin/sh' as the default shell. You may pass any flags supported by this command beforethe resource name, and an optional command after the resource name, which will be executedinstead of a login shell. A TTY will be automatically allocated if standard input isinteractive \- use \-t and \-T to override. A TERM variable is sent to the environment wherethe shell (or command) will be executed. By default its value is the same as the TERMvariable from the local environment; if not set, 'xterm' is used. .PP -Note, some containers may not include a shell \- use 'openshift cli exec' if you need to run commands -directly. +Note, some containers may not include a shell \- use 'openshift cli exec' if you need to run commandsdirectly. .SH OPTIONS @@ -125,16 +115,15 @@ directly. .RS .nf - # Open a shell session on the first container in pod 'foo' openshift cli rsh foo - + # Run the command 'cat /etc/resolv.conf' inside pod 'foo' openshift cli rsh foo cat /etc/resolv.conf - + # See the configuration of your internal registry openshift cli rsh dc/docker\-registry cat config.yml - + # Open a shell session on the container named 'index' inside a pod of your job # openshift cli rsh \-c index job/sheduled diff --git a/docs/man/man1/openshift-cli-rsync.1 b/docs/man/man1/openshift-cli-rsync.1 index 7eb13ecc2aaa..58a7ef48602c 100644 --- a/docs/man/man1/openshift-cli-rsync.1 +++ b/docs/man/man1/openshift-cli-rsync.1 @@ -16,16 +16,10 @@ openshift cli rsync \- Copy files between local filesystem and a pod Copy local files to or from a pod container .PP -This command will copy local files to or from a remote container. -It only copies the changed files using the rsync command from your OS. -To ensure optimum performance, install rsync locally. In UNIX systems, -use your package manager. In Windows, install cwRsync from - -\[la]https://www.itefix.net/cwrsync\[ra]. +This command will copy local files to or from a remote container.It only copies the changed files using the rsync command from your OS.To ensure optimum performance, install rsync locally. In UNIX systems,use your package manager. In Windows, install cwRsync fromhttps://www.itefix.net/cwrsync. .PP -If no container is specified, the first container of the pod is used -for the copy. +If no container is specified, the first container of the pod is usedfor the copy. .SH OPTIONS @@ -137,10 +131,9 @@ for the copy. .RS .nf - # Synchronize a local directory with a pod directory openshift cli rsync ./local/dir/ POD:/remote/dir - + # Synchronize a pod directory with a local directory openshift cli rsync POD:/remote/dir/ ./local/dir diff --git a/docs/man/man1/openshift-cli-run.1 b/docs/man/man1/openshift-cli-run.1 index d9a8586d85d7..3f961d6fb4e8 100644 --- a/docs/man/man1/openshift-cli-run.1 +++ b/docs/man/man1/openshift-cli-run.1 @@ -16,9 +16,7 @@ openshift cli run \- Run a particular image on the cluster Create and run a particular image, possibly replicated .PP -Creates a deployment config to manage the created container(s). You can choose to run in the -foreground for an interactive container execution. You may pass 'run/v1' to -\-\-generator to create a replication controller instead of a deployment config. +Creates a deployment config to manage the created container(s). You can choose to run in theforeground for an interactive container execution. You may pass 'run/v1' to\-\-generator to create a replication controller instead of a deployment config. .SH OPTIONS @@ -236,17 +234,17 @@ foreground for an interactive container execution. You may pass 'run/v1' to .nf # Starts a single instance of nginx. openshift cli run nginx \-\-image=nginx - + # Starts a replicated instance of nginx. openshift cli run nginx \-\-image=nginx \-\-replicas=5 - + # Dry run. Print the corresponding API objects without creating them. openshift cli run nginx \-\-image=nginx \-\-dry\-run - + # Start a single instance of nginx, but overload the spec of the replication # controller with a partial set of values parsed from JSON. openshift cli run nginx \-\-image=nginx \-\-overrides='{ "apiVersion": "v1", "spec": { ... } }' - + # Start a single instance of nginx and keep it in the foreground, don't restart it if it exits. openshift cli run \-i \-\-tty nginx \-\-image=nginx \-\-restart=Never diff --git a/docs/man/man1/openshift-cli-scale.1 b/docs/man/man1/openshift-cli-scale.1 index b9f049e317fe..9def1616b9d9 100644 --- a/docs/man/man1/openshift-cli-scale.1 +++ b/docs/man/man1/openshift-cli-scale.1 @@ -16,14 +16,10 @@ openshift cli scale \- Change the number of pods in a deployment Set a new size for a deployment or replication controller .PP -Scale also allows users to specify one or more preconditions for the scale action. -If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the -scale is attempted, and it is guaranteed that the precondition holds true when the -scale is sent to the server. +Scale also allows users to specify one or more preconditions for the scale action.If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before thescale is attempted, and it is guaranteed that the precondition holds true when thescale is sent to the server. .PP -Note that scaling a deployment configuration with no deployments will update the -desired replicas in the configuration template. +Note that scaling a deployment configuration with no deployments will update thedesired replicas in the configuration template. .SH OPTIONS @@ -137,10 +133,10 @@ desired replicas in the configuration template. .nf # Scale replication controller named 'foo' to 3. openshift cli scale \-\-replicas=3 replicationcontrollers foo - + # If the replication controller named foo's current size is 2, scale foo to 3. openshift cli scale \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers foo - + # Scale the latest deployment of 'bar'. In case of no deployment, bar's template # will be scaled instead. openshift cli scale \-\-replicas=10 dc bar diff --git a/docs/man/man1/openshift-cli-secrets-add.1 b/docs/man/man1/openshift-cli-secrets-add.1 index 40c55eeb8f10..6bb261b9e8c6 100644 --- a/docs/man/man1/openshift-cli-secrets-add.1 +++ b/docs/man/man1/openshift-cli-secrets-add.1 @@ -95,10 +95,10 @@ DEPRECATED: This command has been moved to "openshift cli secrets link" .nf # Add an image pull secret to a service account to automatically use it for pulling pod images: openshift cli serviceaccount\-name pull\-secret \-\-for=pull - + # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images: openshift cli builder builder\-image\-secret \-\-for=pull,mount - + # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod: openshift cli pod\-sa pod\-secret diff --git a/docs/man/man1/openshift-cli-secrets-link.1 b/docs/man/man1/openshift-cli-secrets-link.1 index a9f2aa8f3954..cfcd54b17a73 100644 --- a/docs/man/man1/openshift-cli-secrets-link.1 +++ b/docs/man/man1/openshift-cli-secrets-link.1 @@ -16,7 +16,7 @@ openshift cli secrets link \- Link secrets to a ServiceAccount Link secrets to a service account .PP -Linking a secret enables a service account to automatically use that secret for some forms of authentication +Linking a secret enables a service account to automatically use that secret for some forms of authentication. .SH OPTIONS @@ -98,10 +98,10 @@ Linking a secret enables a service account to automatically use that secret for .nf # Add an image pull secret to a service account to automatically use it for pulling pod images: openshift cli secrets link serviceaccount\-name pull\-secret \-\-for=pull - + # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images: openshift cli secrets link builder builder\-image\-secret \-\-for=pull,mount - + # If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod: openshift cli secrets link pod\-sa pod\-secret diff --git a/docs/man/man1/openshift-cli-secrets-new-basicauth.1 b/docs/man/man1/openshift-cli-secrets-new-basicauth.1 index 3ff55115b510..d10de1040aae 100644 --- a/docs/man/man1/openshift-cli-secrets-new-basicauth.1 +++ b/docs/man/man1/openshift-cli-secrets-new-basicauth.1 @@ -19,9 +19,7 @@ Create a new basic authentication secret Basic authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires basic authentication \- username, password. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can provide -this information by creating a 'basicauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires basic authentication \- username, password.In order for the nodes to clone source code on your behalf, they have to have the credentials. You can providethis information by creating a 'basicauth' secret and attaching it to your service account. .SH OPTIONS @@ -149,13 +147,13 @@ this information by creating a 'basicauth' secret and attaching it to your servi .RS .nf - // If your basic authentication method requires only username and password or token, add it by using: + # If your basic authentication method requires only username and password or token, add it by using: openshift cli secrets new\-basicauth SECRET \-\-username=USERNAME \-\-password=PASSWORD - - // If your basic authentication method requires also CA certificate, add it by using: + + # If your basic authentication method requires also CA certificate, add it by using: openshift cli secrets new\-basicauth SECRET \-\-username=USERNAME \-\-password=PASSWORD \-\-ca\-cert=FILENAME - - // If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: + + # If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: openshift cli secrets new SECRET path/to/.gitconfig .fi diff --git a/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 b/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 index 8e8d6829fbeb..8eb138a20efb 100644 --- a/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 +++ b/docs/man/man1/openshift-cli-secrets-new-dockercfg.1 @@ -19,15 +19,10 @@ Create a new dockercfg secret Dockercfg secrets are used to authenticate against Docker registries. .PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. +When using the Docker command line to push images, you can authenticate to a given registry by running'docker login DOCKERREGISTRYSERVER \-\-username=DOCKERUSER \-\-password=DOCKERPASSWORD \-\-email=DOCKER\_EMAIL'.That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands toauthenticate to the registry. .PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. +When creating applications, you may have a Docker registry that requires authentication. In order for thenodes to pull images on your behalf, they have to have the credentials. You can provide this informationby creating a dockercfg secret and attaching it to your service account. .SH OPTIONS @@ -154,13 +149,13 @@ by creating a dockercfg secret and attaching it to your service account. .nf # Create a new .dockercfg secret: openshift cli secrets new\-dockercfg SECRET \-\-docker\-server=DOCKER\_REGISTRY\_SERVER \-\-docker\-username=DOCKER\_USER \-\-docker\-password=DOCKER\_PASSWORD \-\-docker\-email=DOCKER\_EMAIL - + # Create a new .dockercfg secret from an existing file: openshift cli secrets new SECRET path/to/.dockercfg - + # Create a new .docker/config.json secret from an existing file: openshift cli secrets new SECRET .dockerconfigjson=path/to/.docker/config.json - + # To add new secret to 'imagePullSecrets' for the node, or 'secrets' for builds, use: openshift cli edit SERVICE\_ACCOUNT diff --git a/docs/man/man1/openshift-cli-secrets-new-sshauth.1 b/docs/man/man1/openshift-cli-secrets-new-sshauth.1 index 7cee54219ab6..13760a9687e2 100644 --- a/docs/man/man1/openshift-cli-secrets-new-sshauth.1 +++ b/docs/man/man1/openshift-cli-secrets-new-sshauth.1 @@ -19,9 +19,7 @@ Create a new SSH authentication secret SSH authentication secrets are used to authenticate against SCM servers. .PP -When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key. -In order for the nodes to clone source code on your behalf, they have to have the credentials. You can -provide this information by creating a 'sshauth' secret and attaching it to your service account. +When creating applications, you may have a SCM server that requires SSH authentication \- private SSH key.In order for the nodes to clone source code on your behalf, they have to have the credentials. You canprovide this information by creating a 'sshauth' secret and attaching it to your service account. .SH OPTIONS @@ -141,13 +139,13 @@ provide this information by creating a 'sshauth' secret and attaching it to your .RS .nf - // If your SSH authentication method requires only private SSH key, add it by using: + # If your SSH authentication method requires only private SSH key, add it by using: openshift cli secrets new\-sshauth SECRET \-\-ssh\-privatekey=FILENAME - - // If your SSH authentication method requires also CA certificate, add it by using: + + # If your SSH authentication method requires also CA certificate, add it by using: openshift cli secrets new\-sshauth SECRET \-\-ssh\-privatekey=FILENAME \-\-ca\-cert=FILENAME - - // If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: + + # If you do already have a .gitconfig file needed for authentication, you can create a gitconfig secret by using: openshift cli secrets new SECRET path/to/.gitconfig .fi diff --git a/docs/man/man1/openshift-cli-secrets-new.1 b/docs/man/man1/openshift-cli-secrets-new.1 index 3f887db7eaa8..727c214ad6d0 100644 --- a/docs/man/man1/openshift-cli-secrets-new.1 +++ b/docs/man/man1/openshift-cli-secrets-new.1 @@ -16,9 +16,7 @@ openshift cli secrets new \- Create a new secret based on a key file or on files Create a new secret based on a file or directory .PP -Key files can be specified using their file path, in which case a default name will be given to them, or optionally -with a name and file path, in which case the given name will be used. Specifying a directory will create a secret -using with all valid keys in that directory. +Key files can be specified using their file path, in which case a default name will be given to them, or optionallywith a name and file path, in which case the given name will be used. Specifying a directory will create a secretusing with all valid keys in that directory. .SH OPTIONS @@ -140,16 +138,16 @@ using with all valid keys in that directory. .nf # Create a new secret named my\-secret with a key named ssh\-privatekey openshift cli secrets new my\-secret \~/.ssh/ssh\-privatekey - + # Create a new secret named my\-secret with keys named ssh\-privatekey and ssh\-publickey instead of the names of the keys on disk openshift cli secrets new my\-secret ssh\-privatekey=\~/.ssh/id\_rsa ssh\-publickey=\~/.ssh/id\_rsa.pub - + # Create a new secret named my\-secret with keys for each file in the folder "bar" openshift cli secrets new my\-secret path/to/bar - + # Create a new .dockercfg secret named my\-secret openshift cli secrets new my\-secret path/to/.dockercfg - + # Create a new .docker/config.json secret named my\-secret openshift cli secrets new my\-secret .dockerconfigjson=path/to/.docker/config.json diff --git a/docs/man/man1/openshift-cli-secrets-unlink.1 b/docs/man/man1/openshift-cli-secrets-unlink.1 index b0bed408a171..c9c609f8df2c 100644 --- a/docs/man/man1/openshift-cli-secrets-unlink.1 +++ b/docs/man/man1/openshift-cli-secrets-unlink.1 @@ -90,8 +90,8 @@ If a secret is no longer valid for a pod, build or image pull, you may unlink it .RS .nf - # Unlink a secret currently associated with a service account: -openshift cli secrets unlink serviceaccount\-name secret\-name another\-secret\-name ... + # Unlink a secret currently associated with a service account: + openshift cli secrets unlink serviceaccount\-name secret\-name another\-secret\-name ... .fi .RE diff --git a/docs/man/man1/openshift-cli-secrets.1 b/docs/man/man1/openshift-cli-secrets.1 index b453a0026582..441c18c94bd3 100644 --- a/docs/man/man1/openshift-cli-secrets.1 +++ b/docs/man/man1/openshift-cli-secrets.1 @@ -16,9 +16,7 @@ openshift cli secrets \- Manage secrets Manage secrets in your project .PP -Secrets are used to store confidential information that should not be contained inside of an image. -They are commonly used to hold things like keys for authentication to other internal systems like -Docker registries. +Secrets are used to store confidential information that should not be contained inside of an image.They are commonly used to hold things like keys for authentication to other internal systems likeDocker registries. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 b/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 index 0a41ccfb24a7..7e95a17d37e7 100644 --- a/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 +++ b/docs/man/man1/openshift-cli-serviceaccounts-get-token.1 @@ -19,9 +19,7 @@ Get a token assigned to a service account. If the service account has multiple tokens, the first token found will be returned. .PP -Service account API tokens are used by service accounts to authenticate to the API. -Client actions using a service account token will be executed as if the service account -itself were making the actions. +Service account API tokens are used by service accounts to authenticate to the API.Client actions using a service account token will be executed as if the service accountitself were making the actions. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -98,7 +96,6 @@ itself were making the actions. # Get the service account token from service account 'default' openshift cli serviceaccounts get\-token 'default' - .fi .RE diff --git a/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 b/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 index 4186c98b3ddf..7611633f8878 100644 --- a/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 +++ b/docs/man/man1/openshift-cli-serviceaccounts-new-token.1 @@ -16,11 +16,7 @@ openshift cli serviceaccounts new\-token \- Generate a new token for a service a Generate a new token for a service account. .PP -Service account API tokens are used by service accounts to authenticate to the API. -This command will generate a new token, which could be used to compartmentalize service -account actions by executing them with distinct tokens, to rotate out pre\-existing token -on the service account, or for use by an external client. If a label is provided, it will -be applied to any created token so that tokens created with this command can be idenitifed. +Service account API tokens are used by service accounts to authenticate to the API.This command will generate a new token, which could be used to compartmentalize serviceaccount actions by executing them with distinct tokens, to rotate out pre\-existing tokenon the service account, or for use by an external client. If a label is provided, it willbe applied to any created token so that tokens created with this command can be idenitifed. .SH OPTIONS @@ -106,12 +102,11 @@ be applied to any created token so that tokens created with this command can be .nf # Generate a new token for service account 'default' openshift cli serviceaccounts new\-token 'default' - + # Generate a new token for service account 'default' and apply # labels 'foo' and 'bar' to the new token for identification # openshift cli serviceaccounts new\-token 'default' \-\-labels foo=foo\-value,bar=bar\-value - .fi .RE diff --git a/docs/man/man1/openshift-cli-set-build-hook.1 b/docs/man/man1/openshift-cli-set-build-hook.1 index c3c2221f9149..c06043bbdaec 100644 --- a/docs/man/man1/openshift-cli-set-build-hook.1 +++ b/docs/man/man1/openshift-cli-set-build-hook.1 @@ -19,17 +19,10 @@ Set or remove a build hook on a build config Build hooks allow behavior to be injected into the build process. .PP -A post\-commit build hook is executed after a build has committed an image but before the -image has been pushed to a registry. It can be used to execute tests on the image and verify -it before it is made available in a registry or for any other logic that is needed to execute -before the image is pushed to the registry. A new container with the recently built image is -launched with the build hook command. If the command or script run by the build hook returns a -non\-zero exit code, the resulting image will not be pushed to the registry. +A post\-commit build hook is executed after a build has committed an image but before theimage has been pushed to a registry. It can be used to execute tests on the image and verifyit before it is made available in a registry or for any other logic that is needed to executebefore the image is pushed to the registry. A new container with the recently built image islaunched with the build hook command. If the command or script run by the build hook returns anon\-zero exit code, the resulting image will not be pushed to the registry. .PP -The command for a build hook may be specified as a shell script (with the \-\-script argument), -as a new entrypoint command on the image with the \-\-command argument, or as a set of -arguments to the image's entrypoint (default). +The command for a build hook may be specified as a shell script (with the \-\-script argument),as a new entrypoint command on the image with the \-\-command argument, or as a set ofarguments to the image's entrypoint (default). .SH OPTIONS @@ -167,13 +160,13 @@ arguments to the image's entrypoint (default). .nf # Clear post\-commit hook on a build config openshift cli set build\-hook bc/mybuild \-\-post\-commit \-\-remove - + # Set the post\-commit hook to execute a test suite using a new entrypoint openshift cli set build\-hook bc/mybuild \-\-post\-commit \-\-command \-\- /bin/bash \-c /var/lib/test\-image.sh - + # Set the post\-commit hook to execute a shell script openshift cli set build\-hook bc/mybuild \-\-post\-commit \-\-script="/var/lib/test\-image.sh param1 param2 \&\& /var/lib/done.sh" - + # Set the post\-commit hook as a set of arguments to the default image entrypoint openshift cli set build\-hook bc/mybuild \-\-post\-commit \-\- arg1 arg2 diff --git a/docs/man/man1/openshift-cli-set-deployment-hook.1 b/docs/man/man1/openshift-cli-set-deployment-hook.1 index 1ec80cee7417..b5a8eb7097e2 100644 --- a/docs/man/man1/openshift-cli-set-deployment-hook.1 +++ b/docs/man/man1/openshift-cli-set-deployment-hook.1 @@ -16,29 +16,19 @@ openshift cli set deployment\-hook \- Update a deployment hook on a deployment c Set or remove a deployment hook on a deployment config .PP -Deployment configs allow hooks to execute at different points in the lifecycle of the -deployment, depending on the deployment strategy. +Deployment configs allow hooks to execute at different points in the lifecycle of thedeployment, depending on the deployment strategy. .PP -For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified. -The Pre hook will execute before the deployment starts. The Mid hook will execute once the -previous deployment has been scaled down to 0, but before the new one ramps up. -The Post hook will execute once the deployment has completed. +For deployments with a Recreate strategy, a Pre, Mid, and Post hook can be specified.The Pre hook will execute before the deployment starts. The Mid hook will execute once theprevious deployment has been scaled down to 0, but before the new one ramps up.The Post hook will execute once the deployment has completed. .PP -For deployments with a Rolling strategy, a Pre and Post hook can be specified. -The Pre hook will execute before the deployment starts and the Post hook will execute once -the deployment has completed. +For deployments with a Rolling strategy, a Pre and Post hook can be specified.The Pre hook will execute before the deployment starts and the Post hook will execute oncethe deployment has completed. .PP -For each hook, a new pod will be started using one of the containers in the deployment's pod -template with a specific command to execute. Additional environment variables may be specified -for the hook, as well as which volumes from the pod template will be mounted on the hook pod. +For each hook, a new pod will be started using one of the containers in the deployment's podtemplate with a specific command to execute. Additional environment variables may be specifiedfor the hook, as well as which volumes from the pod template will be mounted on the hook pod. .PP -Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellation -policies can be set on all hooks. For example, a Post hook on a rolling strategy does not support -the abort policy, because at that point the deployment has already happened. +Each hook can have its own cancellation policy. One of: abort, retry, or ignore. Not all cancellationpolicies can be set on all hooks. For example, a Post hook on a rolling strategy does not supportthe abort policy, because at that point the deployment has already happened. .SH OPTIONS @@ -192,11 +182,11 @@ the abort policy, because at that point the deployment has already happened. .nf # Clear pre and post hooks on a deployment config openshift cli set deployment\-hook dc/myapp \-\-remove \-\-pre \-\-post - + # Set the pre deployment hook to execute a db migration command for an application # using the data volume from the application openshift cli set deployment\-hook dc/myapp \-\-pre \-v data \-\- /var/lib/migrate\-db.sh - + # Set a mid deployment hook along with additional environment variables openshift cli set deployment\-hook dc/myapp \-\-mid \-v data \-e VAR1=value1 \-e VAR2=value2 \-\- /var/lib/prepare\-deploy.sh diff --git a/docs/man/man1/openshift-cli-set-env.1 b/docs/man/man1/openshift-cli-set-env.1 index 85ba87bce5c0..8e136e564522 100644 --- a/docs/man/man1/openshift-cli-set-env.1 +++ b/docs/man/man1/openshift-cli-set-env.1 @@ -16,17 +16,10 @@ openshift cli set env \- Update environment variables on a pod template Update environment variables on a pod template or a build config .PP -List environment variable definitions in one or more pods, pod templates or build -configuration. -Add, update, or remove container environment variable definitions in one or -more pod templates (within replication controllers or deployment configurations) or -build configurations. -View or modify the environment variable definitions on all containers in the -specified pods or pod templates, or just those that match a wildcard. +List environment variable definitions in one or more pods, pod templates or buildconfiguration.Add, update, or remove container environment variable definitions in one ormore pod templates (within replication controllers or deployment configurations) orbuild configurations.View or modify the environment variable definitions on all containers in thespecified pods or pod templates, or just those that match a wildcard. .PP -If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard env -syntax. +If "\-\-env \-" is passed, environment variables can be read from STDIN using the standard envsyntax. .SH OPTIONS @@ -156,32 +149,32 @@ syntax. .nf # Update deployment 'registry' with a new environment variable openshift cli set env dc/registry STORAGE\_DIR=/local - + # List the environment variables defined on a build config 'sample\-build' openshift cli set env bc/sample\-build \-\-list - + # List the environment variables defined on all pods openshift cli set env pods \-\-all \-\-list - + # Output modified build config in YAML, and does not alter the object on the server openshift cli set env bc/sample\-build STORAGE\_DIR=/data \-o yaml - + # Update all containers in all replication controllers in the project to have ENV=prod openshift cli set env rc \-\-all ENV=prod - + # Import environment from a secret openshift cli set env \-\-from=secret/mysecret dc/myapp - + # Import environment from a config map with a prefix openshift cli set env \-\-from=configmap/myconfigmap \-\-prefix=MYSQL\_ dc/myapp - + # Remove the environment variable ENV from container 'c1' in all deployment configs openshift cli set env dc \-\-all \-\-containers="c1" ENV\- - + # Remove the environment variable ENV from a deployment config definition on disk and # update the deployment config on the server openshift cli set env \-f dc.json ENV\- - + # Set some of the local shell environment into a deployment config on the server env | grep RAILS\_ | openshift cli set env \-e \- dc/registry diff --git a/docs/man/man1/openshift-cli-set-image.1 b/docs/man/man1/openshift-cli-set-image.1 index b848e627fb28..98e6d56be0db 100644 --- a/docs/man/man1/openshift-cli-set-image.1 +++ b/docs/man/man1/openshift-cli-set-image.1 @@ -151,13 +151,13 @@ Update existing container image(s) of resources. .nf # Set a deployment configs's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. openshift cli set image dc/nginx busybox=busybox nginx=nginx:1.9.1 - + # Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' openshift cli set image deployments,rc nginx=nginx:1.9.1 \-\-all - + # Update image of all containers of daemonset abc to 'nginx:1.9.1' openshift cli set image daemonset abc *=nginx:1.9.1 - + # Print result (in yaml format) of updating nginx container image from local file, without hitting the server openshift cli set image \-f path/to/file.yaml nginx=nginx:1.9.1 \-\-local \-o yaml diff --git a/docs/man/man1/openshift-cli-set-probe.1 b/docs/man/man1/openshift-cli-set-probe.1 index b9567da5be94..0b15bacf2e7a 100644 --- a/docs/man/man1/openshift-cli-set-probe.1 +++ b/docs/man/man1/openshift-cli-set-probe.1 @@ -16,13 +16,7 @@ openshift cli set probe \- Update a probe on a pod template Set or remove a liveness or readiness probe from a pod or pod template .PP -Each container in a pod may define one or more probes that are used for general health -checking. A liveness probe is checked periodically to ensure the container is still healthy: -if the probe fails, the container is restarted. Readiness probes set or clear the ready -flag for each container, which controls whether the container's ports are included in the list -of endpoints for a service and whether a deployment can proceed. A readiness check should -indicate when your container is ready to accept incoming traffic or begin handling work. -Setting both liveness and readiness probes for each container is highly recommended. +Each container in a pod may define one or more probes that are used for general healthchecking. A liveness probe is checked periodically to ensure the container is still healthy:if the probe fails, the container is restarted. Readiness probes set or clear the readyflag for each container, which controls whether the container's ports are included in the listof endpoints for a service and whether a deployment can proceed. A readiness check shouldindicate when your container is ready to accept incoming traffic or begin handling work.Setting both liveness and readiness probes for each container is highly recommended. .PP The three probe types are: @@ -35,9 +29,7 @@ The three probe types are: .IP \(bu Run a command in the container that must return exit code 0 .PP -Containers that take a variable amount of time to start should set generous -initial\-delay\-seconds values, otherwise as your application evolves you may suddenly begin -to fail. +Containers that take a variable amount of time to start should set generousinitial\-delay\-seconds values, otherwise as your application evolves you may suddenly beginto fail. .SH OPTIONS @@ -203,19 +195,19 @@ to fail. .nf # Clear both readiness and liveness probes off all containers openshift cli set probe dc/registry \-\-remove \-\-readiness \-\-liveness - + # Set an exec action as a liveness probe to run 'echo ok' openshift cli set probe dc/registry \-\-liveness \-\- echo ok - + # Set a readiness probe to try to open a TCP socket on 3306 openshift cli set probe rc/mysql \-\-readiness \-\-open\-tcp=3306 - + # Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP openshift cli set probe dc/webapp \-\-readiness \-\-get\-url=http://:8080/healthz - + # Set an HTTP readiness probe over HTTPS on 127.0.0.1 for a hostNetwork pod openshift cli set probe dc/router \-\-readiness \-\-get\-url=https://127.0.0.1:1936/stats - + # Set only the initial\-delay\-seconds field on all deployments openshift cli set probe dc \-\-all \-\-readiness \-\-initial\-delay\-seconds=30 diff --git a/docs/man/man1/openshift-cli-set-route-backends.1 b/docs/man/man1/openshift-cli-set-route-backends.1 index 43f87775c9ba..9eb226c07471 100644 --- a/docs/man/man1/openshift-cli-set-route-backends.1 +++ b/docs/man/man1/openshift-cli-set-route-backends.1 @@ -16,34 +16,19 @@ openshift cli set route\-backends \- Update the backends for a route Set and adjust route backends .PP -Routes may have one or more optional backend services with weights controlling how much -traffic flows to each service. Traffic is assigned proportional to the combined weights -of each backend. A weight of zero means that the backend will receive no traffic. If all -weights are zero the route will not send traffic to any backends. +Routes may have one or more optional backend services with weights controlling how muchtraffic flows to each service. Traffic is assigned proportional to the combined weightsof each backend. A weight of zero means that the backend will receive no traffic. If allweights are zero the route will not send traffic to any backends. .PP -When setting backends, the first backend is the primary and the other backends are -considered alternates. For example: +When setting backends, the first backend is the primary and the other backends areconsidered alternates. For example: .PP -.RS - -.nf $ openshift cli set route\-backends web prod=99 canary=1 -.fi -.RE - .PP -will set the primary backend to service "prod" with a weight of 99 and the first -alternate backend to service "canary" with a weight of 1. This means 99% of traffic will -be sent to the service "prod". +will set the primary backend to service "prod" with a weight of 99 and the firstalternate backend to service "canary" with a weight of 1. This means 99% of traffic willbe sent to the service "prod". .PP -The \-\-adjust flag allows you to alter the weight of an individual service relative to -itself or to the primary backend. Specifying a percentage will adjust the backend -relative to either the primary or the first alternate (if you specify the primary). -If there are other backends their weights will be kept proportional to the changed. +The \-\-adjust flag allows you to alter the weight of an individual service relative toitself or to the primary backend. Specifying a percentage will adjust the backendrelative to either the primary or the first alternate (if you specify the primary).If there are other backends their weights will be kept proportional to the changed. .PP Not all routers may support multiple or weighted backends. @@ -180,19 +165,19 @@ Not all routers may support multiple or weighted backends. .nf # Print the backends on the route 'web' openshift cli set route\-backends web - + # Set two backend services on route 'web' with 2/3rds of traffic going to 'a' openshift cli set route\-backends web a=2 b=1 - + # Increase the traffic percentage going to b by 10% relative to a openshift cli set route\-backends web \-\-adjust b=+10% - + # Set traffic percentage going to b to 10% of the traffic going to a openshift cli set route\-backends web \-\-adjust b=10% - + # Set weight of b to 10 openshift cli set route\-backends web \-\-adjust b=10 - + # Set the weight to all backends to zero openshift cli set route\-backends web \-\-zero diff --git a/docs/man/man1/openshift-cli-set-triggers.1 b/docs/man/man1/openshift-cli-set-triggers.1 index eed1026dcd6f..eb756aac13c3 100644 --- a/docs/man/man1/openshift-cli-set-triggers.1 +++ b/docs/man/man1/openshift-cli-set-triggers.1 @@ -16,18 +16,13 @@ openshift cli set triggers \- Update the triggers on a build or deployment confi Set or remove triggers for build configs and deployment configs .PP -All build configs and deployment configs may have a set of triggers that result in a new deployment -or build being created. This command enables you to alter those triggers \- making them automatic or -manual, adding new entries, or changing existing entries. +All build configs and deployment configs may have a set of triggers that result in a new deploymentor build being created. This command enables you to alter those triggers \- making them automatic ormanual, adding new entries, or changing existing entries. .PP -Deployments support triggering off of image changes and on config changes. Config changes are any -alterations to the pod template, while image changes will result in the container image value being -updated whenever an image stream tag is updated. +Deployments support triggering off of image changes and on config changes. Config changes are anyalterations to the pod template, while image changes will result in the container image value beingupdated whenever an image stream tag is updated. .PP -Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specific -and generic). The config change trigger for a build config will only trigger the first build. +Build configs support triggering off of image changes, config changes, and webhooks (both GitHub\-specificand generic). The config change trigger for a build config will only trigger the first build. .SH OPTIONS @@ -189,23 +184,23 @@ and generic). The config change trigger for a build config will only trigger the .nf # Print the triggers on the registry openshift cli set triggers dc/registry - + # Set all triggers to manual openshift cli set triggers dc/registry \-\-manual - + # Enable all automatic triggers openshift cli set triggers dc/registry \-\-auto - + # Reset the GitHub webhook on a build to a new, generated secret openshift cli set triggers bc/webapp \-\-from\-github openshift cli set triggers bc/webapp \-\-from\-webhook - + # Remove all triggers openshift cli set triggers bc/webapp \-\-remove\-all - + # Stop triggering on config change openshift cli set triggers dc/registry \-\-from\-config \-\-remove - + # Add an image trigger to a build config openshift cli set triggers bc/webapp \-\-from\-image=namespace1/image:latest diff --git a/docs/man/man1/openshift-cli-set-volumes.1 b/docs/man/man1/openshift-cli-set-volumes.1 index fca6e9dce5af..4d363eac3e27 100644 --- a/docs/man/man1/openshift-cli-set-volumes.1 +++ b/docs/man/man1/openshift-cli-set-volumes.1 @@ -16,36 +16,23 @@ openshift cli set volumes \- Update volumes on a pod template Update volumes on a pod template .PP -This command can add, update or remove volumes from containers for any object -that has a pod template (deployment configs, replication controllers, or pods). -You can list volumes in pod or any object that has a pod template. You can -specify a single object or multiple, and alter volumes on all containers or -just those that match a given name. +This command can add, update or remove volumes from containers for any objectthat has a pod template (deployment configs, replication controllers, or pods).You can list volumes in pod or any object that has a pod template. You canspecify a single object or multiple, and alter volumes on all containers orjust those that match a given name. .PP -If you alter a volume setting on a deployment config, a deployment will be -triggered. Changing a replication controller will not affect running pods, and -you cannot change a pod's volumes once it has been created. +If you alter a volume setting on a deployment config, a deployment will betriggered. Changing a replication controller will not affect running pods, andyou cannot change a pod's volumes once it has been created. .PP Volume types include: .IP .IP -\(bu emptydir (empty directory) \fIdefault\fP -A directory allocated when the pod is created on a local host, is removed when -the pod is deleted and is not copied across servers +\(bu emptydir (empty directory)default: A directory allocated when the pod iscreated on a local host, is removed when the pod is deleted and is not copiedacross servers .IP -\(bu hostdir (host directory) -A directory with specific path on any host (requires elevated privileges) +\(bu hostdir (host directory): A directory with specific path on any host(requires elevated privileges) .IP -\(bu persistentvolumeclaim or pvc (persistent volume claim) -Link the volume directory in the container to a persistent volume claim you have -allocated by name \- a persistent volume claim is a request to allocate storage. -Note that if your claim hasn't been bound, your pods will not start. +\(bu persistentvolumeclaim or pvc (persistent volume claim): Link the volumedirectory in the container to a persistent volume claim you have allocated byname \- a persistent volume claim is a request to allocate storage. Note thatif your claim hasn't been bound, your pods will not start. .IP -\(bu secret (mounted secret) -Secret volumes mount a named secret to the provided directory. +\(bu secret (mounted secret): Secret volumes mount a named secret to the provideddirectory. .PP For descriptions on other volume types, see \[la]https://docs.openshift.com\[ra] @@ -210,27 +197,27 @@ For descriptions on other volume types, see .nf # List volumes defined on all deployment configs in the current project openshift cli set volume dc \-\-all - + # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry openshift cli set volume dc/registry \-\-add \-\-mount\-path=/var/lib/registry - + # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' openshift cli set volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-name=pvc1 \-\-overwrite - + # Remove volume 'v1' from deployment config 'registry' openshift cli set volume dc/registry \-\-remove \-\-name=v1 - + # Create a new persistent volume claim that overwrites an existing volume 'v1' openshift cli set volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-size=1G \-\-overwrite - + # Change the mount point for volume 'v1' to /data openshift cli set volume dc/registry \-\-add \-\-name=v1 \-m /data \-\-overwrite - + # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) openshift cli set volume dc/registry \-\-remove \-\-name=v1 \-\-containers=c1 - + # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) openshift cli set volume dc/registry \-\-add \-m /repo \-\-source= diff --git a/docs/man/man1/openshift-cli-start-build.1 b/docs/man/man1/openshift-cli-start-build.1 index 884d2df93394..04ad2f8a9295 100644 --- a/docs/man/man1/openshift-cli-start-build.1 +++ b/docs/man/man1/openshift-cli-start-build.1 @@ -16,17 +16,10 @@ openshift cli start\-build \- Start a new build Start a build .PP -This command starts a new build for the provided build config or copies an existing build using -\-\-from\-build=. Pass the \-\-follow flag to see output from the build. +This command starts a new build for the provided build config or copies an existing build using\-\-from\-build=. Pass the \-\-follow flag to see output from the build. .PP -In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, -\-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build -and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be -used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the -file is placed in the root of an empty directory with the same filename. Note that builds -triggered from binary input will not preserve the source on the server, so rebuilds triggered by -base image changes will use the source specified on the build config. +In addition, you can pass a file, directory, or source code repository with the \-\-from\-file,\-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the buildand override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can beused to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, thefile is placed in the root of an empty directory with the same filename. Note that buildstriggered from binary input will not preserve the source on the server, so rebuilds triggered bybase image changes will use the source specified on the build config. .SH OPTIONS @@ -160,20 +153,20 @@ base image changes will use the source specified on the build config. .nf # Starts build from build config "hello\-world" openshift cli start\-build hello\-world - + # Starts build from a previous build "hello\-world\-1" openshift cli start\-build \-\-from\-build=hello\-world\-1 - + # Use the contents of a directory as build input openshift cli start\-build hello\-world \-\-from\-dir=src/ - + # Send the contents of a Git repository to the server from tag 'v2' openshift cli start\-build hello\-world \-\-from\-repo=../hello\-world \-\-commit=v2 - + # Start a new build for build config "hello\-world" and watch the logs until the build # completes or fails. openshift cli start\-build hello\-world \-\-follow - + # Start a new build for build config "hello\-world" and wait until the build completes. It # exits with a non\-zero return code if the build fails. openshift cli start\-build hello\-world \-\-wait diff --git a/docs/man/man1/openshift-cli-status.1 b/docs/man/man1/openshift-cli-status.1 index 5d6fb9c1e55b..901898a35e1d 100644 --- a/docs/man/man1/openshift-cli-status.1 +++ b/docs/man/man1/openshift-cli-status.1 @@ -16,14 +16,10 @@ openshift cli status \- Show an overview of the current project Show a high level overview of the current project .PP -This command will show services, deployment configs, build configurations, and active deployments. -If you have any misconfigured components information about them will be shown. For more information -about individual items, use the describe command (e.g. openshift cli describe buildConfig, -openshift cli describe deploymentConfig, openshift cli describe service). +This command will show services, deployment configs, build configurations, and active deployments.If you have any misconfigured components information about them will be shown. For more informationabout individual items, use the describe command (e.g. openshift cli describe buildConfig,openshift cli describe deploymentConfig, openshift cli describe service). .PP -You can specify an output format of "\-o dot" to have this command output the generated status -graph in DOT format that is suitable for use by the "dot" command. +You can specify an output format of "\-o dot" to have this command output the generated statusgraph in DOT format that is suitable for use by the "dot" command. .SH OPTIONS @@ -113,10 +109,10 @@ graph in DOT format that is suitable for use by the "dot" command. .nf # See an overview of the current project. openshift cli status - + # Export the overview of the current project in an svg file. openshift cli status \-o dot | dot \-T svg \-o project.svg - + # See an overview of the current project including details for any identified issues. openshift cli status \-v diff --git a/docs/man/man1/openshift-cli-tag.1 b/docs/man/man1/openshift-cli-tag.1 index c9791a8e3ef6..39b52014d86a 100644 --- a/docs/man/man1/openshift-cli-tag.1 +++ b/docs/man/man1/openshift-cli-tag.1 @@ -16,17 +16,10 @@ openshift cli tag \- Tag existing images into image streams Tag existing images into image streams .PP -The tag command allows you to take an existing tag or image from an image -stream, or a Docker image pull spec, and set it as the most recent image for a -tag in 1 or more other image streams. It is similar to the 'docker tag' -command, but it operates on image streams instead. +The tag command allows you to take an existing tag or image from an imagestream, or a Docker image pull spec, and set it as the most recent image for atag in 1 or more other image streams. It is similar to the 'docker tag'command, but it operates on image streams instead. .PP -Pass the \-\-insecure flag if your external registry does not have a valid HTTPS -certificate, or is only served over HTTP. Pass \-\-scheduled to have the server -regularly check the tag for updates and import the latest version (which can -then trigger builds and deployments). Note that \-\-scheduled is only allowed for -Docker images. +Pass the \-\-insecure flag if your external registry does not have a valid HTTPScertificate, or is only served over HTTP. Pass \-\-scheduled to have the serverregularly check the tag for updates and import the latest version (which canthen trigger builds and deployments). Note that \-\-scheduled is only allowed forDocker images. .SH OPTIONS @@ -128,13 +121,13 @@ Docker images. .nf # Tag the current image for the image stream 'openshift/ruby' and tag '2.0' into the image stream 'yourproject/ruby with tag 'tip'. openshift cli tag openshift/ruby:2.0 yourproject/ruby:tip - + # Tag a specific image. openshift cli tag openshift/ruby@sha256:6b646fa6bf5e5e4c7fa41056c27910e679c03ebe7f93e361e6515a9da7e258cc yourproject/ruby:tip - + # Tag an external Docker image. openshift cli tag \-\-source=docker openshift/origin:latest yourproject/ruby:tip - + # Remove the specified spec tag from an image stream. openshift cli tag openshift/origin:latest \-d diff --git a/docs/man/man1/openshift-cli-types.1 b/docs/man/man1/openshift-cli-types.1 index 411ac6c36b1c..0475c37e941f 100644 --- a/docs/man/man1/openshift-cli-types.1 +++ b/docs/man/man1/openshift-cli-types.1 @@ -16,10 +16,7 @@ openshift cli types \- An introduction to concepts and types Concepts and Types .PP -Kubernetes and OpenShift help developers and operators build, test, and deploy -applications in a containerized cloud environment. Applications may be composed -of all of the components below, although most developers will be concerned with -Services, Deployments, and Builds for delivering changes. +Kubernetes and OpenShift help developers and operators build, test, and deployapplications in a containerized cloud environment. Applications may be composedof all of the components below, although most developers will be concerned withServices, Deployments, and Builds for delivering changes. .PP Concepts: @@ -239,13 +236,13 @@ For more, see .nf # View all projects you have access to openshift cli get projects - + # See a list of all services in the current project openshift cli get svc - + # Describe a deployment configuration in detail openshift cli describe dc mydeploymentconfig - + # Show the images tagged into an image stream openshift cli describe is ruby\-centos7 diff --git a/docs/man/man1/openshift-cli-volumes.1 b/docs/man/man1/openshift-cli-volumes.1 index 345ec7da652b..3307a44e34b8 100644 --- a/docs/man/man1/openshift-cli-volumes.1 +++ b/docs/man/man1/openshift-cli-volumes.1 @@ -175,27 +175,27 @@ DEPRECATED: This command has been moved to "openshift cli set volume" .nf # List volumes defined on all deployment configs in the current project openshift cli volume dc \-\-all - + # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry openshift cli volume dc/registry \-\-add \-\-mount\-path=/var/lib/registry - + # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' openshift cli volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-name=pvc1 \-\-overwrite - + # Remove volume 'v1' from deployment config 'registry' openshift cli volume dc/registry \-\-remove \-\-name=v1 - + # Create a new persistent volume claim that overwrites an existing volume 'v1' openshift cli volume dc/registry \-\-add \-\-name=v1 \-t pvc \-\-claim\-size=1G \-\-overwrite - + # Change the mount point for volume 'v1' to /data openshift cli volume dc/registry \-\-add \-\-name=v1 \-m /data \-\-overwrite - + # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) openshift cli volume dc/registry \-\-remove \-\-name=v1 \-\-containers=c1 - + # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) openshift cli volume dc/registry \-\-add \-m /repo \-\-source= diff --git a/docs/man/man1/openshift-cli-whoami.1 b/docs/man/man1/openshift-cli-whoami.1 index accaa1d4cf12..abecc40f79e4 100644 --- a/docs/man/man1/openshift-cli-whoami.1 +++ b/docs/man/man1/openshift-cli-whoami.1 @@ -16,9 +16,7 @@ openshift cli whoami \- Return information about the current session Show information about the current session .PP -The default options for this command will return the currently authenticated user name -or an empty string. Other flags support returning the currently used token or the -user context. +The default options for this command will return the currently authenticated user nameor an empty string. Other flags support returning the currently used token or theuser context. .SH OPTIONS diff --git a/docs/man/man1/openshift-cli.1 b/docs/man/man1/openshift-cli.1 index 6cc608135d49..6ee15f1eaaf7 100644 --- a/docs/man/man1/openshift-cli.1 +++ b/docs/man/man1/openshift-cli.1 @@ -16,9 +16,7 @@ openshift cli \- Command line tools for managing applications OpenShift Client .PP -This client helps you develop, build, deploy, and run your applications on any OpenShift or -Kubernetes compatible platform. It also includes the administrative commands for managing a -cluster under the 'adm' subcommand. +This client helps you develop, build, deploy, and run your applications on anyOpenShift or Kubernetes compatible platform. It also includes the administrativecommands for managing a cluster under the 'adm' subcommand. .SH OPTIONS diff --git a/docs/man/man1/openshift-completion.1 b/docs/man/man1/openshift-completion.1 index 041b4038a3d2..acbf21275d3d 100644 --- a/docs/man/man1/openshift-completion.1 +++ b/docs/man/man1/openshift-completion.1 @@ -13,8 +13,7 @@ openshift completion \- Output shell completion code for the given shell (bash o .SH DESCRIPTION .PP -This command prints shell code which must be evaluated to provide interactive -completion of openshift commands. +This command prints shell code which must be evaluated to provide interactivecompletion of openshift commands. .SH OPTIONS INHERITED FROM PARENT COMMANDS @@ -35,18 +34,19 @@ completion of openshift commands. # Generate the openshift completion code for bash openshift completion bash > bash\_completion.sh source bash\_completion.sh - + # The above example depends on the bash\-completion framework. - It must be sourced before sourcing the openshift cli completion, i.e. on the Mac: - + # It must be sourced before sourcing the openshift cli completion, + # i.e. on the Mac: + brew install bash\-completion source $(brew \-\-prefix)/etc/bash\_completion openshift completion bash > bash\_completion.sh source bash\_completion.sh - + # In zsh*, the following will load openshift cli zsh completion: source <(openshift completion zsh) - + * zsh completions are only supported in versions of zsh >= 5.2 .fi diff --git a/docs/man/man1/openshift-ex-build-chain.1 b/docs/man/man1/openshift-ex-build-chain.1 index 7d08f34d1c00..1d9a6f386526 100644 --- a/docs/man/man1/openshift-ex-build-chain.1 +++ b/docs/man/man1/openshift-ex-build-chain.1 @@ -16,9 +16,7 @@ openshift ex build\-chain \- Output the inputs and dependencies of your builds Output the inputs and dependencies of your builds .PP -Supported formats for the generated graph are dot and a human\-readable output. -Tag and namespace are optional and if they are not specified, 'latest' and the -default namespace will be used respectively. +Supported formats for the generated graph are dot and a human\-readable output.Tag and namespace are optional and if they are not specified, 'latest' and thedefault namespace will be used respectively. .SH OPTIONS @@ -112,10 +110,10 @@ default namespace will be used respectively. .nf # Build the dependency tree for the 'latest' tag in openshift ex build\-chain - + # Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility openshift ex build\-chain :v2 \-o dot | dot \-T svg \-o deps.svg - + # Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace openshift ex build\-chain \-n test \-\-all diff --git a/docs/man/man1/openshift-ex-config-patch.1 b/docs/man/man1/openshift-ex-config-patch.1 index 87e0681c1446..56e67aa128b9 100644 --- a/docs/man/man1/openshift-ex-config-patch.1 +++ b/docs/man/man1/openshift-ex-config-patch.1 @@ -97,9 +97,8 @@ Patch the master\-config.yaml or node\-config.yaml .RS .nf - -# Set the auditConfig.enabled value to true -%[1]s openshift.local.config/master/master\-config.yaml \-\-patch='{"auditConfig": {"enabled": true}}' + # Set the auditConfig.enabled value to true + %[1]s openshift.local.config/master/master\-config.yaml \-\-patch='{"auditConfig": {"enabled": true}}' .fi .RE diff --git a/docs/man/man1/openshift-ex-diagnostics.1 b/docs/man/man1/openshift-ex-diagnostics.1 index d2b464397993..1424ee8c3136 100644 --- a/docs/man/man1/openshift-ex-diagnostics.1 +++ b/docs/man/man1/openshift-ex-diagnostics.1 @@ -13,59 +13,32 @@ openshift ex diagnostics \- Diagnose common cluster problems .SH DESCRIPTION .PP -This utility helps troubleshoot and diagnose known problems. It runs -diagnostics using a client and/or the state of a running master / -node host. +This utility helps troubleshoot and diagnose known problems. It runsdiagnostics using a client and/or the state of a running master /node host. .PP -.RS - -.nf openshift ex diagnostics -.fi -.RE - .PP -If run without flags, it will check for standard config files for -client, master, and node, and if found, use them for diagnostics. -You may also specify config files explicitly with flags, in which case -you will receive an error if they are not found. For example: +If run without flags, it will check for standard config files forclient, master, and node, and if found, use them for diagnostics.You may also specify config files explicitly with flags, in which caseyou will receive an error if they are not found. For example: .PP -.RS - -.nf openshift ex diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml - -.fi -.RE .IP .IP -\(bu If master/node config files are not found and the \-\-host flag is not -present, host diagnostics are skipped. +\(bu If master/node config files are not found and the \-\-host flag is notpresent, host diagnostics are skipped. .IP -\(bu If the client has cluster\-admin access, this access enables cluster -diagnostics to run which regular users cannot. +\(bu If the client has cluster\-admin access, this access enables clusterdiagnostics to run which regular users cannot. .IP -\(bu If a client config file is not found, client and cluster diagnostics -are skipped. +\(bu If a client config file is not found, client and cluster diagnosticsare skipped. .PP Diagnostics may be individually run by passing diagnostic name as arguments. .PP -.RS - -.nf openshift ex diagnostics -.fi -.RE - .PP -The available diagnostic names are: -AggregatedLogging AnalyzeLogs ClusterRegistry ClusterRoleBindings ClusterRoles ClusterRouter ConfigContexts DiagnosticPod MasterConfigCheck MasterNode MetricsApiProxy NodeConfigCheck NodeDefinitions ServiceExternalIPs UnitStatus +The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegistry, ClusterRoleBindings, ClusterRoles, ClusterRouter, ConfigContexts, DiagnosticPod, MasterConfigCheck, MasterNode, MetricsApiProxy, NodeConfigCheck, NodeDefinitions, ServiceExternalIPs, UnitStatus. .SH OPTIONS diff --git a/docs/man/man1/openshift-ex-ipfailover.1 b/docs/man/man1/openshift-ex-ipfailover.1 index f2916c8f647b..989651153133 100644 --- a/docs/man/man1/openshift-ex-ipfailover.1 +++ b/docs/man/man1/openshift-ex-ipfailover.1 @@ -16,17 +16,10 @@ openshift ex ipfailover \- Install an IP failover group to a set of nodes Configure or view IP Failover configuration .PP -This command helps to setup an IP failover configuration for the -cluster. An administrator can configure IP failover on an entire -cluster or on a subset of nodes (as defined via a labeled selector). +This command helps to setup an IP failover configuration for thecluster. An administrator can configure IP failover on an entirecluster or on a subset of nodes (as defined via a labeled selector). .PP -If an IP failover configuration does not exist with the given name, -the \-\-create flag can be passed to create a deployment configuration that -will provide IP failover capability. If you are running in production, it is -recommended that the labeled selector for the nodes matches at least 2 nodes -to ensure you have failover protection, and that you provide a \-\-replicas= -value that matches the number of nodes for the given labeled selector. +If an IP failover configuration does not exist with the given name,the \-\-create flag can be passed to create a deployment configuration thatwill provide IP failover capability. If you are running in production, it isrecommended that the labeled selector for the nodes matches at least 2 nodesto ensure you have failover protection, and that you provide a \-\-replicas=value that matches the number of nodes for the given labeled selector. .SH OPTIONS @@ -164,18 +157,18 @@ value that matches the number of nodes for the given labeled selector. .nf # Check the default IP failover configuration ("ipfailover"): openshift ex ipfailover - + # See what the IP failover configuration would look like if it is created: openshift ex ipfailover \-o json - + # Create an IP failover configuration if it does not already exist: openshift ex ipfailover ipf \-\-virtual\-ips="10.1.1.1\-4" \-\-create - + # Create an IP failover configuration on a selection of nodes labeled # "router=us\-west\-ha" (on 4 nodes with 7 virtual IPs monitoring a service # listening on port 80, such as the router process). openshift ex ipfailover ipfailover \-\-selector="router=us\-west\-ha" \-\-virtual\-ips="1.2.3.4,10.1.1.100\-104,5.6.7.8" \-\-watch\-port=80 \-\-replicas=4 \-\-create - + # Use a different IP failover config image and see the configuration: openshift ex ipfailover ipf\-alt \-\-selector="hagroup=us\-west\-ha" \-\-virtual\-ips="1.2.3.4" \-o yaml \-\-images=myrepo/myipfailover:mytag diff --git a/docs/man/man1/openshift-ex-prune-groups.1 b/docs/man/man1/openshift-ex-prune-groups.1 index 8160fbc68777..8c53664a92f0 100644 --- a/docs/man/man1/openshift-ex-prune-groups.1 +++ b/docs/man/man1/openshift-ex-prune-groups.1 @@ -16,13 +16,7 @@ openshift ex prune\-groups \- Prune OpenShift groups referencing missing records Prune OpenShift Groups referencing missing records on from an external provider. .PP -In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish -to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have -been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. -The path to a sync configuration file that was used for syncing the groups in question is required in order to -describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups -for which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirm -flag. +In order to prune OpenShift Group records using those from an external provider, determine which Groups you wishto prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that havebeen synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.The path to a sync configuration file that was used for syncing the groups in question is required in order todescribe how data is requested from the external record store. Default behavior is to indicate all OpenShift groupsfor which the external record does not exist, to run the pruning process and commit the results, use the \-\-confirmflag. .SH OPTIONS @@ -116,17 +110,16 @@ flag. .nf # Prune all orphaned groups openshift ex prune\-groups \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups except the ones from the blacklist file openshift ex prune\-groups \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist file openshift ex prune\-groups \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Prune all orphaned groups from a list of specific groups specified in a whitelist openshift ex prune\-groups groups/group\_name groups/other\_name \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-ex-sync-groups.1 b/docs/man/man1/openshift-ex-sync-groups.1 index 4b9d9319257d..f35e63a42aa0 100644 --- a/docs/man/man1/openshift-ex-sync-groups.1 +++ b/docs/man/man1/openshift-ex-sync-groups.1 @@ -16,13 +16,7 @@ openshift ex sync\-groups \- Sync OpenShift groups with records from an external Sync OpenShift Groups with records from an external provider. .PP -In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish -to sync and where their records live. For instance, all or some groups may be selected from the current Groups -stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those -stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is -requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-run -without changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by the -LDAP query templates. +In order to sync OpenShift Group records with those from an external provider, determine which Groups you wishto sync and where their records live. For instance, all or some groups may be selected from the current Groupsstored in OpenShift that have been synced previously, or similarly all or some groups may be selected from thosestored on an LDAP server. The path to a sync configuration file is required in order to describe how data isrequested from the external record store and migrated to OpenShift records. Default behavior is to do a dry\-runwithout changing OpenShift records. Passing '\-\-confirm' will sync all groups from the LDAP server returned by theLDAP query templates. .SH OPTIONS @@ -152,20 +146,19 @@ LDAP query templates. .nf # Sync all groups from an LDAP server openshift ex sync\-groups \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync all groups except the ones from the blacklist file from an LDAP server openshift ex sync\-groups \-\-blacklist=/path/to/blacklist.txt \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific groups specified in a whitelist file with an LDAP server openshift ex sync\-groups \-\-whitelist=/path/to/whitelist.txt \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - + # Sync all OpenShift Groups that have been synced previously with an LDAP server openshift ex sync\-groups \-\-type=openshift \-\-sync\-config=/path/to/ldap\-sync\-config.yaml \-\-confirm - + # Sync specific OpenShift Groups if they have been synced previously with an LDAP server openshift ex sync\-groups groups/group1 groups/group2 groups/group3 \-\-sync\-config=/path/to/sync\-config.yaml \-\-confirm - .fi .RE diff --git a/docs/man/man1/openshift-ex-validate-master-config.1 b/docs/man/man1/openshift-ex-validate-master-config.1 index 014d5cc7c3fd..7854fc85e779 100644 --- a/docs/man/man1/openshift-ex-validate-master-config.1 +++ b/docs/man/man1/openshift-ex-validate-master-config.1 @@ -90,7 +90,7 @@ This command validates that a configuration file intended to be used for a maste .RS .nf - // Validate master server configuration file + # Validate master server configuration file openshift ex validate master\-config openshift.local.config/master/master\-config.yaml .fi diff --git a/docs/man/man1/openshift-ex-validate-node-config.1 b/docs/man/man1/openshift-ex-validate-node-config.1 index 7a5606bfc249..ba20a5d78f13 100644 --- a/docs/man/man1/openshift-ex-validate-node-config.1 +++ b/docs/man/man1/openshift-ex-validate-node-config.1 @@ -90,7 +90,7 @@ This command validates that a configuration file intended to be used for a node .RS .nf - // Validate node configuration file + # Validate node configuration file openshift ex validate node\-config openshift.local.config/master/node\-config.yaml .fi diff --git a/docs/man/man1/openshift-infra-deploy.1 b/docs/man/man1/openshift-infra-deploy.1 index 737184e6b883..79c88fb9d743 100644 --- a/docs/man/man1/openshift-infra-deploy.1 +++ b/docs/man/man1/openshift-infra-deploy.1 @@ -16,9 +16,7 @@ openshift infra deploy \- Run the deployer Perform a deployment .PP -This command launches a deployment as described by a deployment configuration. It accepts the name -of a replication controller created by a deployment and runs that deployment to completion. You can -use the \-\-until flag to run the deployment until you reach the specified condition. +This command launches a deployment as described by a deployment configuration. It accepts the nameof a replication controller created by a deployment and runs that deployment to completion. You canuse the \-\-until flag to run the deployment until you reach the specified condition. .PP Available conditions: @@ -45,8 +43,7 @@ Available conditions: .IP \(bu "100%" All after the deployment is at full scale, but before the post hook runs .PP -Unrecognized conditions will be ignored and the deployment will run to completion. You can run this -command multiple times when \-\-until is specified \- hooks will only be executed once. +Unrecognized conditions will be ignored and the deployment will run to completion. You can run thiscommand multiple times when \-\-until is specified \- hooks will only be executed once. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-diagnostic-pod.1 b/docs/man/man1/openshift-infra-diagnostic-pod.1 index 0d737ae10c48..14a7f5020a99 100644 --- a/docs/man/man1/openshift-infra-diagnostic-pod.1 +++ b/docs/man/man1/openshift-infra-diagnostic-pod.1 @@ -13,8 +13,7 @@ openshift infra diagnostic\-pod \- Within a pod, run pod diagnostics .SH DESCRIPTION .PP -This utility is intended to run diagnostics inside a container and -log the results so that the calling diagnostic can report them. +This utility is intended to run diagnostics inside a container andlog the results so that the calling diagnostic can report them. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-docker-build.1 b/docs/man/man1/openshift-infra-docker-build.1 index c630e0c18aaa..59c7f71e0138 100644 --- a/docs/man/man1/openshift-infra-docker-build.1 +++ b/docs/man/man1/openshift-infra-docker-build.1 @@ -16,8 +16,7 @@ openshift infra docker\-build \- Run a Docker build Perform a Docker build .PP -This command executes a Docker build using arguments passed via the environment. -It expects to be run inside of a container. +This command executes a Docker build using arguments passed via the environment.It expects to be run inside of a container. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-infra-f5-router.1 b/docs/man/man1/openshift-infra-f5-router.1 index d7151dc734ca..d1b44ca904c3 100644 --- a/docs/man/man1/openshift-infra-f5-router.1 +++ b/docs/man/man1/openshift-infra-f5-router.1 @@ -19,10 +19,7 @@ Start an F5 route synchronizer This command launches a process that will synchronize an F5 to the route configuration of your master. .PP -You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client has -access to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or all -namespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Note -that you must have a cluster\-wide administrative role to view all namespaces. +You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client hasaccess to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or allnamespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Notethat you must have a cluster\-wide administrative role to view all namespaces. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-router.1 b/docs/man/man1/openshift-infra-router.1 index 703f72c29526..62a86fba6dfd 100644 --- a/docs/man/man1/openshift-infra-router.1 +++ b/docs/man/man1/openshift-infra-router.1 @@ -16,21 +16,16 @@ openshift infra router \- Start a router Start a router .PP -This command launches a router connected to your cluster master. The router listens for routes and endpoints -created by users and keeps a local router configuration up to date with those changes. +This command launches a router connected to your cluster master. The router listens for routes and endpointscreated by users and keeps a local router configuration up to date with those changes. .PP You may customize the router by providing your own \-\-template and \-\-reload scripts. .PP -The router must have a default certificate in pem format. You may provide it via \-\-default\-cert otherwise -one is automatically created. +The router must have a default certificate in pem format. You may provide it via \-\-default\-cert otherwiseone is automatically created. .PP -You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client has -access to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or all -namespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Note -that you must have a cluster\-wide administrative role to view all namespaces. +You may restrict the set of routes exposed to a single project (with \-\-namespace), projects your client hasaccess to with a set of labels (\-\-project\-labels), namespaces matching a label (\-\-namespace\-labels), or allnamespaces (no argument). You can limit the routes to those matching a \-\-labels or \-\-fields selector. Notethat you must have a cluster\-wide administrative role to view all namespaces. .SH OPTIONS diff --git a/docs/man/man1/openshift-infra-sti-build.1 b/docs/man/man1/openshift-infra-sti-build.1 index 2be6b4f1f41e..6934f4d721cb 100644 --- a/docs/man/man1/openshift-infra-sti-build.1 +++ b/docs/man/man1/openshift-infra-sti-build.1 @@ -16,8 +16,7 @@ openshift infra sti\-build \- Run a Source\-to\-Image build Perform a Source\-to\-Image build .PP -This command executes a Source\-to\-Image build using arguments passed via the environment. -It expects to be run inside of a container. +This command executes a Source\-to\-Image build using arguments passed via the environment.It expects to be run inside of a container. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-start-etcd.1 b/docs/man/man1/openshift-start-etcd.1 index b8af264bfd0e..b9afe0d055c7 100644 --- a/docs/man/man1/openshift-start-etcd.1 +++ b/docs/man/man1/openshift-start-etcd.1 @@ -16,15 +16,13 @@ openshift start etcd \- Launch etcd server Start an etcd server for testing. .PP -This command starts an etcd server based on the config for testing. It is not -intended for production use. Running +This command starts an etcd server based on the config for testing. It is notintended for production use. Running .PP openshift start etcd .PP -will start the server listening for incoming requests. The server will run in -the foreground until you terminate the process. +will start the server listening for incoming requests. The server will run inthe foreground until you terminate the process. .SH OPTIONS diff --git a/docs/man/man1/openshift-start-master-api.1 b/docs/man/man1/openshift-start-master-api.1 index 42fec5782e34..3235aaa3aebc 100644 --- a/docs/man/man1/openshift-start-master-api.1 +++ b/docs/man/man1/openshift-start-master-api.1 @@ -22,8 +22,7 @@ This command starts the master API. Running openshift start master api .PP -will start the server listening for incoming API requests. The server -will run in the foreground until you terminate the process. +will start the server listening for incoming API requests. The serverwill run in the foreground until you terminate the process. .SH OPTIONS diff --git a/docs/man/man1/openshift-start-master-controllers.1 b/docs/man/man1/openshift-start-master-controllers.1 index 6ab444b804cc..b2eccfbee7da 100644 --- a/docs/man/man1/openshift-start-master-controllers.1 +++ b/docs/man/man1/openshift-start-master-controllers.1 @@ -22,8 +22,7 @@ This command starts the controllers for the master. Running openshift start master controllers .PP -will start the controllers that manage the master state, including the scheduler. The controllers -will run in the foreground until you terminate the process. +will start the controllers that manage the master state, including the scheduler. The controllerswill run in the foreground until you terminate the process. .SH OPTIONS diff --git a/docs/man/man1/openshift-start-master.1 b/docs/man/man1/openshift-start-master.1 index 5dd0797f9f1b..ed64d9260ee3 100644 --- a/docs/man/man1/openshift-start-master.1 +++ b/docs/man/man1/openshift-start-master.1 @@ -22,20 +22,16 @@ This command helps you launch a master server. Running openshift start master .PP -will start a master listening on all interfaces, launch an etcd server to store -persistent data, and launch the Kubernetes system components. The server will run in the -foreground until you terminate the process. +will start a master listening on all interfaces, launch an etcd server to storepersistent data, and launch the Kubernetes system components. The server will run in theforeground until you terminate the process. .PP -Note: starting the master without passing the \-\-master address will attempt to find the IP -address that will be visible inside running Docker containers. This is not always successful, -so if you have problems tell the master what public address it should use via \-\-master=. +Note: starting the master without passing the \-\-master address will attempt to find the IPaddress that will be visible inside running Docker containers. This is not always successful,so if you have problems tell the master what public address it should use via \-\-master=. .PP -You may also pass \-\-etcd=
to connect to an external etcd server. +You may also pass \-\-etcd=
to connect to an external etcd server. .PP -You may also pass \-\-kubeconfig= to connect to an external Kubernetes cluster. +You may also pass \-\-kubeconfig=to connect to an external Kubernetes cluster. .SH OPTIONS diff --git a/docs/man/man1/openshift-start-network.1 b/docs/man/man1/openshift-start-network.1 index bf2abf7034bb..f9d0e08ab65d 100644 --- a/docs/man/man1/openshift-start-network.1 +++ b/docs/man/man1/openshift-start-network.1 @@ -22,8 +22,7 @@ This command helps you launch node networking. Running openshift start network \-\-config= .PP -will start the network proxy and SDN plugins with given configuration file. The proxy will -run in the foreground until you terminate the process. +will start the network proxy and SDN plugins with given configuration file. The proxy willrun in the foreground until you terminate the process. .SH OPTIONS diff --git a/docs/man/man1/openshift-start-node.1 b/docs/man/man1/openshift-start-node.1 index 7c406dfc5279..b0eee54a3580 100644 --- a/docs/man/man1/openshift-start-node.1 +++ b/docs/man/man1/openshift-start-node.1 @@ -22,8 +22,7 @@ This command helps you launch a node. Running openshift start node \-\-config= .PP -will start a node with given configuration file. The node will run in the -foreground until you terminate the process. +will start a node with given configuration file. The node will run in theforeground until you terminate the process. .SH OPTIONS diff --git a/docs/man/man1/openshift-start.1 b/docs/man/man1/openshift-start.1 index 66f7b3bf2b80..9d6ed6739e55 100644 --- a/docs/man/man1/openshift-start.1 +++ b/docs/man/man1/openshift-start.1 @@ -16,28 +16,22 @@ openshift start \- Launch all\-in\-one server Start an all\-in\-one server .PP -This command helps you launch an all\-in\-one server, which allows you to run all of the -components of an enterprise Kubernetes system on a server with Docker. Running: +This command helps you launch an all\-in\-one server, which allows you to run all of thecomponents of an enterprise Kubernetes system on a server with Docker. Running: .PP openshift start .PP -will start listening on all interfaces, launch an etcd server to store persistent -data, and launch the Kubernetes system components. The server will run in the foreground until -you terminate the process. This command delegates to "openshift start master" and -"openshift start node". +will start listening on all interfaces, launch an etcd server to store persistentdata, and launch the Kubernetes system components. The server will run in the foreground untilyou terminate the process. This command delegates to "openshift start master" and"openshift start node". .PP -Note: starting OpenShift without passing the \-\-master address will attempt to find the IP -address that will be visible inside running Docker containers. This is not always successful, -so if you have problems tell OpenShift what public address it will be via \-\-master=. +Note: starting OpenShift without passing the \-\-master address will attempt to find the IPaddress that will be visible inside running Docker containers. This is not always successful,so if you have problems tell OpenShift what public address it will be via \-\-master=. .PP -You may also pass \-\-etcd=
to connect to an external etcd server. +You may also pass \-\-etcd=
to connect to an external etcd server. .PP -You may also pass \-\-kubeconfig= to connect to an external Kubernetes cluster. +You may also pass \-\-kubeconfig=to connect to an external Kubernetes cluster. .SH OPTIONS diff --git a/docs/man/man1/openshift.1 b/docs/man/man1/openshift.1 index 5d3d1919e901..89fa7d1bbb1b 100644 --- a/docs/man/man1/openshift.1 +++ b/docs/man/man1/openshift.1 @@ -16,11 +16,10 @@ openshift \- Build, deploy, and manage your cloud applications OpenShift Application Platform .PP -The OpenShift distribution of Kubernetes helps you build, deploy, and manage your applications on top of -Docker containers. To start an all\-in\-one server with the default configuration, run: +The OpenShift distribution of Kubernetes helps you build, deploy, and manage your applications on top ofDocker containers. To start an all\-in\-one server with the default configuration, run: .PP -openshift start \& +$ openshift start \& .SH OPTIONS diff --git a/pkg/bootstrap/docker/openshift/admin.go b/pkg/bootstrap/docker/openshift/admin.go index 5019f08d1bc4..c2102ea7964e 100644 --- a/pkg/bootstrap/docker/openshift/admin.go +++ b/pkg/bootstrap/docker/openshift/admin.go @@ -67,13 +67,8 @@ func (h *Helper) InstallRegistry(kubeClient kclient.Interface, f *clientcmd.Fact } // InstallRouter installs a default router on the OpenShift server -<<<<<<< 87bfcb6d27559fadd05bfcb45d26274d57934a46 -func (h *Helper) InstallRouter(kubeClient kclient.Interface, f *clientcmd.Factory, configDir, images, hostIP string, portForwarding bool, out io.Writer) error { - _, err := kubeClient.Services(DefaultNamespace).Get(SvcRouter) -======= func (h *Helper) InstallRouter(kubeClient kclient.Interface, f *clientcmd.Factory, configDir, images, hostIP string, portForwarding bool, out, errout io.Writer) error { - _, err := kubeClient.Services("default").Get(svcRouter) ->>>>>>> Commands must use the provided err output + _, err := kubeClient.Services(DefaultNamespace).Get(SvcRouter) if err == nil { // Router service already exists, nothing to do return nil diff --git a/pkg/cmd/cli/cli.go b/pkg/cmd/cli/cli.go index f457c2e1af32..d1d94eb8ba22 100644 --- a/pkg/cmd/cli/cli.go +++ b/pkg/cmd/cli/cli.go @@ -205,20 +205,9 @@ func NewCommandCLI(name, fullName string, in io.Reader, out, errout io.Writer) * } cmds.AddCommand(cmd.NewCmdOptions(out)) - setOutput(cmds, out) - return cmds } -func setOutput(cmd *cobra.Command, out io.Writer) { - if cmd.HasSubCommands() { - for _, subCmd := range cmd.Commands() { - setOutput(subCmd, out) - } - } - cmd.SetOutput(out) -} - func moved(fullName, to string, parent, cmd *cobra.Command) string { cmd.Long = fmt.Sprintf("DEPRECATED: This command has been moved to \"%s %s\"", fullName, to) cmd.Short = fmt.Sprintf("DEPRECATED: %s", to) diff --git a/pkg/cmd/cli/cmd/login/helpers.go b/pkg/cmd/cli/cmd/login/helpers.go index c9107f6a7a03..641bfcd23e60 100644 --- a/pkg/cmd/cli/cmd/login/helpers.go +++ b/pkg/cmd/cli/cmd/login/helpers.go @@ -10,16 +10,17 @@ import ( "net/url" "os" - cmdutil "github.com/openshift/origin/pkg/cmd/util" "github.com/openshift/origin/pkg/client" "github.com/openshift/origin/pkg/user/api" + clientcmdapi "k8s.io/kubernetes/pkg/client/unversioned/clientcmd/api" + "github.com/openshift/origin/pkg/cmd/util/term" kapi "k8s.io/kubernetes/pkg/api" kerrors "k8s.io/kubernetes/pkg/api/errors" - "github.com/openshift/origin/pkg/cmd/util/term" "k8s.io/kubernetes/pkg/client/restclient" kclientcmdapi "k8s.io/kubernetes/pkg/client/unversioned/clientcmd/api" "k8s.io/kubernetes/pkg/util/sets" + kterm "k8s.io/kubernetes/pkg/util/term" ) // getMatchingClusters examines the kubeconfig for all clusters that point to the same server @@ -95,7 +96,7 @@ func promptForInsecureTLS(reader io.Reader, out io.Writer, reason error) bool { } } var input bool - if term.IsTerminal(reader) { + if kterm.IsTerminal(reader) { if len(insecureTLSRequestReason) > 0 { fmt.Fprintln(out, insecureTLSRequestReason) } diff --git a/pkg/cmd/cli/cmd/request_project.go b/pkg/cmd/cli/cmd/request_project.go index 3cfffc414b4c..165edc5fe60e 100644 --- a/pkg/cmd/cli/cmd/request_project.go +++ b/pkg/cmd/cli/cmd/request_project.go @@ -73,7 +73,7 @@ To switch to this project and start adding applications, use: ) // NewCmdRequestProject implement the OpenShift cli RequestProject command. -func NewCmdRequestProject(name, baseName string, f *clientcmd.Factory, out io.Writer) *cobra.Command { +func NewCmdRequestProject(name, baseName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command { o := &NewProjectOptions{} o.Out = out o.Name = baseName