From 3278289b126bd86f33f15b8db4366bf11c20a932 Mon Sep 17 00:00:00 2001 From: Clayton Coleman Date: Fri, 22 Jul 2016 13:00:51 -0400 Subject: [PATCH] generated: cmd changes --- contrib/completions/bash/oadm | 162 +++++++++ contrib/completions/bash/oc | 159 +++++++++ contrib/completions/bash/openshift | 324 ++++++++++++++++++ contrib/completions/zsh/oadm | 162 +++++++++ contrib/completions/zsh/oc | 159 +++++++++ contrib/completions/zsh/openshift | 324 ++++++++++++++++++ docs/generated/oadm_by_example_content.adoc | 48 +++ docs/generated/oc_by_example_content.adoc | 48 +++ docs/man/man1/.files_generated_oadm | 3 + docs/man/man1/.files_generated_oc | 3 + docs/man/man1/.files_generated_openshift | 6 + docs/man/man1/oadm-migrate-image-references.1 | 176 ++++++++++ docs/man/man1/oadm-migrate-storage.1 | 165 +++++++++ docs/man/man1/oadm-migrate.1 | 95 +++++ docs/man/man1/oadm.1 | 2 +- .../man1/oc-adm-migrate-image-references.1 | 176 ++++++++++ docs/man/man1/oc-adm-migrate-storage.1 | 165 +++++++++ docs/man/man1/oc-adm-migrate.1 | 95 +++++ docs/man/man1/oc-adm.1 | 2 +- ...openshift-admin-migrate-image-references.1 | 176 ++++++++++ .../man1/openshift-admin-migrate-storage.1 | 165 +++++++++ docs/man/man1/openshift-admin-migrate.1 | 95 +++++ docs/man/man1/openshift-admin.1 | 2 +- ...enshift-cli-adm-migrate-image-references.1 | 176 ++++++++++ .../man1/openshift-cli-adm-migrate-storage.1 | 165 +++++++++ docs/man/man1/openshift-cli-adm-migrate.1 | 95 +++++ docs/man/man1/openshift-cli-adm.1 | 2 +- 27 files changed, 3146 insertions(+), 4 deletions(-) create mode 100644 docs/man/man1/oadm-migrate-image-references.1 create mode 100644 docs/man/man1/oadm-migrate-storage.1 create mode 100644 docs/man/man1/oadm-migrate.1 create mode 100644 docs/man/man1/oc-adm-migrate-image-references.1 create mode 100644 docs/man/man1/oc-adm-migrate-storage.1 create mode 100644 docs/man/man1/oc-adm-migrate.1 create mode 100644 docs/man/man1/openshift-admin-migrate-image-references.1 create mode 100644 docs/man/man1/openshift-admin-migrate-storage.1 create mode 100644 docs/man/man1/openshift-admin-migrate.1 create mode 100644 docs/man/man1/openshift-cli-adm-migrate-image-references.1 create mode 100644 docs/man/man1/openshift-cli-adm-migrate-storage.1 create mode 100644 docs/man/man1/openshift-cli-adm-migrate.1 diff --git a/contrib/completions/bash/oadm b/contrib/completions/bash/oadm index 71b217822022..bfb6db4a3dff 100644 --- a/contrib/completions/bash/oadm +++ b/contrib/completions/bash/oadm @@ -2957,6 +2957,167 @@ _oadm_build-chain() noun_aliases=() } +_oadm_migrate_image-references() +{ + last_command="oadm_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oadm_migrate_storage() +{ + last_command="oadm_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oadm_migrate() +{ + last_command="oadm_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _oadm_create-kubeconfig() { last_command="oadm_create-kubeconfig" @@ -3843,6 +4004,7 @@ _oadm() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") diff --git a/contrib/completions/bash/oc b/contrib/completions/bash/oc index 9242d5929b09..10a72254041b 100644 --- a/contrib/completions/bash/oc +++ b/contrib/completions/bash/oc @@ -6943,6 +6943,164 @@ _oc_adm_build-chain() noun_aliases=() } +_oc_adm_migrate_image-references() +{ + last_command="oc_adm_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oc_adm_migrate_storage() +{ + last_command="oc_adm_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oc_adm_migrate() +{ + last_command="oc_adm_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _oc_adm_create-kubeconfig() { last_command="oc_adm_create-kubeconfig" @@ -7768,6 +7926,7 @@ _oc_adm() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") diff --git a/contrib/completions/bash/openshift b/contrib/completions/bash/openshift index 5a7ee7c02dfe..b092015198a8 100644 --- a/contrib/completions/bash/openshift +++ b/contrib/completions/bash/openshift @@ -3605,6 +3605,167 @@ _openshift_admin_build-chain() noun_aliases=() } +_openshift_admin_migrate_image-references() +{ + last_command="openshift_admin_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_admin_migrate_storage() +{ + last_command="openshift_admin_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_admin_migrate() +{ + last_command="openshift_admin_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _openshift_admin_create-kubeconfig() { last_command="openshift_admin_create-kubeconfig" @@ -4448,6 +4609,7 @@ _openshift_admin() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") @@ -11206,6 +11368,167 @@ _openshift_cli_adm_build-chain() noun_aliases=() } +_openshift_cli_adm_migrate_image-references() +{ + last_command="openshift_cli_adm_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_cli_adm_migrate_storage() +{ + last_command="openshift_cli_adm_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_cli_adm_migrate() +{ + last_command="openshift_cli_adm_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _openshift_cli_adm_create-kubeconfig() { last_command="openshift_cli_adm_create-kubeconfig" @@ -12049,6 +12372,7 @@ _openshift_cli_adm() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") diff --git a/contrib/completions/zsh/oadm b/contrib/completions/zsh/oadm index 2617f42d7a99..442b9f4fe467 100644 --- a/contrib/completions/zsh/oadm +++ b/contrib/completions/zsh/oadm @@ -3118,6 +3118,167 @@ _oadm_build-chain() noun_aliases=() } +_oadm_migrate_image-references() +{ + last_command="oadm_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oadm_migrate_storage() +{ + last_command="oadm_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oadm_migrate() +{ + last_command="oadm_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _oadm_create-kubeconfig() { last_command="oadm_create-kubeconfig" @@ -4004,6 +4165,7 @@ _oadm() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") diff --git a/contrib/completions/zsh/oc b/contrib/completions/zsh/oc index d689c49a92a0..f4bf2c3c3b92 100644 --- a/contrib/completions/zsh/oc +++ b/contrib/completions/zsh/oc @@ -7104,6 +7104,164 @@ _oc_adm_build-chain() noun_aliases=() } +_oc_adm_migrate_image-references() +{ + last_command="oc_adm_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oc_adm_migrate_storage() +{ + last_command="oc_adm_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_oc_adm_migrate() +{ + last_command="oc_adm_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _oc_adm_create-kubeconfig() { last_command="oc_adm_create-kubeconfig" @@ -7929,6 +8087,7 @@ _oc_adm() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") diff --git a/contrib/completions/zsh/openshift b/contrib/completions/zsh/openshift index ece939ca8447..051e0bea7461 100644 --- a/contrib/completions/zsh/openshift +++ b/contrib/completions/zsh/openshift @@ -3766,6 +3766,167 @@ _openshift_admin_build-chain() noun_aliases=() } +_openshift_admin_migrate_image-references() +{ + last_command="openshift_admin_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_admin_migrate_storage() +{ + last_command="openshift_admin_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_admin_migrate() +{ + last_command="openshift_admin_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _openshift_admin_create-kubeconfig() { last_command="openshift_admin_create-kubeconfig" @@ -4609,6 +4770,7 @@ _openshift_admin() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") @@ -11367,6 +11529,167 @@ _openshift_cli_adm_build-chain() noun_aliases=() } +_openshift_cli_adm_migrate_image-references() +{ + last_command="openshift_cli_adm_migrate_image-references" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_cli_adm_migrate_storage() +{ + last_command="openshift_cli_adm_migrate_storage" + commands=() + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--all-namespaces") + flags+=("--confirm") + flags+=("--filename=") + flags_with_completion+=("--filename") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + two_word_flags+=("-f") + flags_with_completion+=("-f") + flags_completion+=("__handle_filename_extension_flag json|yaml|yml") + flags+=("--from-key=") + flags+=("--include=") + flags+=("--output=") + two_word_flags+=("-o") + flags+=("--to-key=") + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_flag+=("--filename=") + must_have_one_flag+=("-f") + must_have_one_noun=() + noun_aliases=() +} + +_openshift_cli_adm_migrate() +{ + last_command="openshift_cli_adm_migrate" + commands=() + commands+=("image-references") + commands+=("storage") + + flags=() + two_word_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--api-version=") + flags+=("--as=") + flags+=("--certificate-authority=") + flags_with_completion+=("--certificate-authority") + flags_completion+=("_filedir") + flags+=("--client-certificate=") + flags_with_completion+=("--client-certificate") + flags_completion+=("_filedir") + flags+=("--client-key=") + flags_with_completion+=("--client-key") + flags_completion+=("_filedir") + flags+=("--cluster=") + flags+=("--config=") + flags_with_completion+=("--config") + flags_completion+=("_filedir") + flags+=("--context=") + flags+=("--google-json-key=") + flags+=("--insecure-skip-tls-verify") + flags+=("--log-flush-frequency=") + flags+=("--loglevel=") + flags+=("--logspec=") + flags+=("--match-server-version") + flags+=("--namespace=") + two_word_flags+=("-n") + flags+=("--server=") + flags+=("--token=") + flags+=("--user=") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + _openshift_cli_adm_create-kubeconfig() { last_command="openshift_cli_adm_create-kubeconfig" @@ -12210,6 +12533,7 @@ _openshift_cli_adm() commands+=("diagnostics") commands+=("prune") commands+=("build-chain") + commands+=("migrate") commands+=("create-kubeconfig") commands+=("create-api-client-config") commands+=("create-bootstrap-project-template") diff --git a/docs/generated/oadm_by_example_content.adoc b/docs/generated/oadm_by_example_content.adoc index b179017e0dcf..048a39f3b355 100644 --- a/docs/generated/oadm_by_example_content.adoc +++ b/docs/generated/oadm_by_example_content.adoc @@ -353,6 +353,54 @@ Manage nodes - list pods, evacuate, or mark ready ==== +== oadm migrate image-references +Update embedded Docker image references + +==== + +[options="nowrap"] +---- + # 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 +---- +==== + + +== oadm migrate storage +Update the stored version of API objects + +==== + +[options="nowrap"] +---- + # 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 + +---- +==== + + == oadm pod-network join-projects Join project network diff --git a/docs/generated/oc_by_example_content.adoc b/docs/generated/oc_by_example_content.adoc index dbb3a0086d7a..3cfc4183992b 100644 --- a/docs/generated/oc_by_example_content.adoc +++ b/docs/generated/oc_by_example_content.adoc @@ -353,6 +353,54 @@ Manage nodes - list pods, evacuate, or mark ready ==== +== oc adm migrate image-references +Update embedded Docker image references + +==== + +[options="nowrap"] +---- + # 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 +---- +==== + + +== oc adm migrate storage +Update the stored version of API objects + +==== + +[options="nowrap"] +---- + # 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 + +---- +==== + + == oc adm pod-network join-projects Join project network diff --git a/docs/man/man1/.files_generated_oadm b/docs/man/man1/.files_generated_oadm index 409abac715ef..37ce35adbb44 100644 --- a/docs/man/man1/.files_generated_oadm +++ b/docs/man/man1/.files_generated_oadm @@ -39,6 +39,9 @@ oadm-groups-sync.1 oadm-groups.1 oadm-ipfailover.1 oadm-manage-node.1 +oadm-migrate-image-references.1 +oadm-migrate-storage.1 +oadm-migrate.1 oadm-new-project.1 oadm-options.1 oadm-overwrite-policy.1 diff --git a/docs/man/man1/.files_generated_oc b/docs/man/man1/.files_generated_oc index 6cd3df38f644..8b1b8b2534dc 100644 --- a/docs/man/man1/.files_generated_oc +++ b/docs/man/man1/.files_generated_oc @@ -39,6 +39,9 @@ oc-adm-groups-sync.1 oc-adm-groups.1 oc-adm-ipfailover.1 oc-adm-manage-node.1 +oc-adm-migrate-image-references.1 +oc-adm-migrate-storage.1 +oc-adm-migrate.1 oc-adm-new-project.1 oc-adm-options.1 oc-adm-overwrite-policy.1 diff --git a/docs/man/man1/.files_generated_openshift b/docs/man/man1/.files_generated_openshift index 6bf0e1cfd060..535e9e014e1e 100644 --- a/docs/man/man1/.files_generated_openshift +++ b/docs/man/man1/.files_generated_openshift @@ -39,6 +39,9 @@ openshift-admin-groups-sync.1 openshift-admin-groups.1 openshift-admin-ipfailover.1 openshift-admin-manage-node.1 +openshift-admin-migrate-image-references.1 +openshift-admin-migrate-storage.1 +openshift-admin-migrate.1 openshift-admin-new-project.1 openshift-admin-options.1 openshift-admin-overwrite-policy.1 @@ -115,6 +118,9 @@ openshift-cli-adm-groups-sync.1 openshift-cli-adm-groups.1 openshift-cli-adm-ipfailover.1 openshift-cli-adm-manage-node.1 +openshift-cli-adm-migrate-image-references.1 +openshift-cli-adm-migrate-storage.1 +openshift-cli-adm-migrate.1 openshift-cli-adm-new-project.1 openshift-cli-adm-options.1 openshift-cli-adm-overwrite-policy.1 diff --git a/docs/man/man1/oadm-migrate-image-references.1 b/docs/man/man1/oadm-migrate-image-references.1 new file mode 100644 index 000000000000..703a53152381 --- /dev/null +++ b/docs/man/man1/oadm-migrate-image-references.1 @@ -0,0 +1,176 @@ +.TH "OADM MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +oadm migrate image\-references \- Update embedded Docker image references + + +.SH SYNOPSIS +.PP +\fBoadm migrate image\-references\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.PP +The following resource types may be migrated by this command: +.IP + +.IP +\(bu images * daemonsets +.IP +\(bu imagestreams * jobs +.IP +\(bu buildconfigs * replicationcontrollers +.IP +\(bu deploymentconfigs * pods +.IP +\(bu secrets (docker) +.PP +Only images, imagestreams, and secrets are updated by default. Updating images and image +streams requires administrative privileges. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[imagestream,image,secrets] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBoadm\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/oadm-migrate-storage.1 b/docs/man/man1/oadm-migrate-storage.1 new file mode 100644 index 000000000000..8eafb221671d --- /dev/null +++ b/docs/man/man1/oadm-migrate-storage.1 @@ -0,0 +1,165 @@ +.TH "OADM MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +oadm migrate storage \- Update the stored version of API objects + + +.SH SYNOPSIS +.PP +\fBoadm migrate storage\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.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 + +.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. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[*] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + + +.SH SEE ALSO +.PP +\fBoadm\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/oadm-migrate.1 b/docs/man/man1/oadm-migrate.1 new file mode 100644 index 000000000000..857824eb0712 --- /dev/null +++ b/docs/man/man1/oadm-migrate.1 @@ -0,0 +1,95 @@ +.TH "OADM" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +oadm migrate \- Migrate data in the cluster + + +.SH SYNOPSIS +.PP +\fBoadm migrate\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +Migrate resources on the cluster + +.PP +These commands assist administrators in performing preventative maintenance on a cluster. + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH SEE ALSO +.PP +\fBoadm(1)\fP, \fBoadm\-migrate\-image\-references(1)\fP, \fBoadm\-migrate\-storage(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/oadm.1 b/docs/man/man1/oadm.1 index a8c1ad4e041b..6e3292a14568 100644 --- a/docs/man/man1/oadm.1 +++ b/docs/man/man1/oadm.1 @@ -88,7 +88,7 @@ actions involve interaction with the command\-line client as well. .SH SEE ALSO .PP -\fBoadm\-router(1)\fP, \fBoadm\-ipfailover(1)\fP, \fBoadm\-registry(1)\fP, \fBoadm\-new\-project(1)\fP, \fBoadm\-policy(1)\fP, \fBoadm\-groups(1)\fP, \fBoadm\-ca(1)\fP, \fBoadm\-overwrite\-policy(1)\fP, \fBoadm\-create\-node\-config(1)\fP, \fBoadm\-manage\-node(1)\fP, \fBoadm\-cordon(1)\fP, \fBoadm\-uncordon(1)\fP, \fBoadm\-drain(1)\fP, \fBoadm\-taint(1)\fP, \fBoadm\-pod\-network(1)\fP, \fBoadm\-diagnostics(1)\fP, \fBoadm\-prune(1)\fP, \fBoadm\-build\-chain(1)\fP, \fBoadm\-create\-kubeconfig(1)\fP, \fBoadm\-create\-api\-client\-config(1)\fP, \fBoadm\-create\-bootstrap\-project\-template(1)\fP, \fBoadm\-create\-bootstrap\-policy\-file(1)\fP, \fBoadm\-create\-login\-template(1)\fP, \fBoadm\-create\-provider\-selection\-template(1)\fP, \fBoadm\-create\-error\-template(1)\fP, \fBoadm\-create\-master\-certs(1)\fP, \fBoadm\-create\-key\-pair(1)\fP, \fBoadm\-create\-server\-cert(1)\fP, \fBoadm\-create\-signer\-cert(1)\fP, \fBoadm\-config(1)\fP, \fBoadm\-completion(1)\fP, \fBoadm\-options(1)\fP, \fBoadm\-version(1)\fP, +\fBoadm\-router(1)\fP, \fBoadm\-ipfailover(1)\fP, \fBoadm\-registry(1)\fP, \fBoadm\-new\-project(1)\fP, \fBoadm\-policy(1)\fP, \fBoadm\-groups(1)\fP, \fBoadm\-ca(1)\fP, \fBoadm\-overwrite\-policy(1)\fP, \fBoadm\-create\-node\-config(1)\fP, \fBoadm\-manage\-node(1)\fP, \fBoadm\-cordon(1)\fP, \fBoadm\-uncordon(1)\fP, \fBoadm\-drain(1)\fP, \fBoadm\-taint(1)\fP, \fBoadm\-pod\-network(1)\fP, \fBoadm\-diagnostics(1)\fP, \fBoadm\-prune(1)\fP, \fBoadm\-build\-chain(1)\fP, \fBoadm\-migrate(1)\fP, \fBoadm\-create\-kubeconfig(1)\fP, \fBoadm\-create\-api\-client\-config(1)\fP, \fBoadm\-create\-bootstrap\-project\-template(1)\fP, \fBoadm\-create\-bootstrap\-policy\-file(1)\fP, \fBoadm\-create\-login\-template(1)\fP, \fBoadm\-create\-provider\-selection\-template(1)\fP, \fBoadm\-create\-error\-template(1)\fP, \fBoadm\-create\-master\-certs(1)\fP, \fBoadm\-create\-key\-pair(1)\fP, \fBoadm\-create\-server\-cert(1)\fP, \fBoadm\-create\-signer\-cert(1)\fP, \fBoadm\-config(1)\fP, \fBoadm\-completion(1)\fP, \fBoadm\-options(1)\fP, \fBoadm\-version(1)\fP, .SH HISTORY diff --git a/docs/man/man1/oc-adm-migrate-image-references.1 b/docs/man/man1/oc-adm-migrate-image-references.1 new file mode 100644 index 000000000000..e3dd0c4d1f56 --- /dev/null +++ b/docs/man/man1/oc-adm-migrate-image-references.1 @@ -0,0 +1,176 @@ +.TH "OC ADM MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +oc adm migrate image\-references \- Update embedded Docker image references + + +.SH SYNOPSIS +.PP +\fBoc adm migrate image\-references\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.PP +The following resource types may be migrated by this command: +.IP + +.IP +\(bu images * daemonsets +.IP +\(bu imagestreams * jobs +.IP +\(bu buildconfigs * replicationcontrollers +.IP +\(bu deploymentconfigs * pods +.IP +\(bu secrets (docker) +.PP +Only images, imagestreams, and secrets are updated by default. Updating images and image +streams requires administrative privileges. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[imagestream,image,secrets] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBoc\-adm\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/oc-adm-migrate-storage.1 b/docs/man/man1/oc-adm-migrate-storage.1 new file mode 100644 index 000000000000..cf30f586b629 --- /dev/null +++ b/docs/man/man1/oc-adm-migrate-storage.1 @@ -0,0 +1,165 @@ +.TH "OC ADM MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +oc adm migrate storage \- Update the stored version of API objects + + +.SH SYNOPSIS +.PP +\fBoc adm migrate storage\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.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 + +.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. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[*] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + + +.SH SEE ALSO +.PP +\fBoc\-adm\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/oc-adm-migrate.1 b/docs/man/man1/oc-adm-migrate.1 new file mode 100644 index 000000000000..f61363d2cf9e --- /dev/null +++ b/docs/man/man1/oc-adm-migrate.1 @@ -0,0 +1,95 @@ +.TH "OC ADM" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +oc adm migrate \- Migrate data in the cluster + + +.SH SYNOPSIS +.PP +\fBoc adm migrate\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +Migrate resources on the cluster + +.PP +These commands assist administrators in performing preventative maintenance on a cluster. + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH SEE ALSO +.PP +\fBoc\-adm(1)\fP, \fBoc\-adm\-migrate\-image\-references(1)\fP, \fBoc\-adm\-migrate\-storage(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/oc-adm.1 b/docs/man/man1/oc-adm.1 index a6de9e61dc43..98708d8a9037 100644 --- a/docs/man/man1/oc-adm.1 +++ b/docs/man/man1/oc-adm.1 @@ -90,7 +90,7 @@ actions involve interaction with the command\-line client as well. .SH SEE ALSO .PP -\fBoc(1)\fP, \fBoc\-adm\-router(1)\fP, \fBoc\-adm\-ipfailover(1)\fP, \fBoc\-adm\-registry(1)\fP, \fBoc\-adm\-new\-project(1)\fP, \fBoc\-adm\-policy(1)\fP, \fBoc\-adm\-groups(1)\fP, \fBoc\-adm\-ca(1)\fP, \fBoc\-adm\-overwrite\-policy(1)\fP, \fBoc\-adm\-create\-node\-config(1)\fP, \fBoc\-adm\-manage\-node(1)\fP, \fBoc\-adm\-cordon(1)\fP, \fBoc\-adm\-uncordon(1)\fP, \fBoc\-adm\-drain(1)\fP, \fBoc\-adm\-taint(1)\fP, \fBoc\-adm\-pod\-network(1)\fP, \fBoc\-adm\-diagnostics(1)\fP, \fBoc\-adm\-prune(1)\fP, \fBoc\-adm\-build\-chain(1)\fP, \fBoc\-adm\-create\-kubeconfig(1)\fP, \fBoc\-adm\-create\-api\-client\-config(1)\fP, \fBoc\-adm\-create\-bootstrap\-project\-template(1)\fP, \fBoc\-adm\-create\-bootstrap\-policy\-file(1)\fP, \fBoc\-adm\-create\-login\-template(1)\fP, \fBoc\-adm\-create\-provider\-selection\-template(1)\fP, \fBoc\-adm\-create\-error\-template(1)\fP, \fBoc\-adm\-create\-master\-certs(1)\fP, \fBoc\-adm\-create\-key\-pair(1)\fP, \fBoc\-adm\-create\-server\-cert(1)\fP, \fBoc\-adm\-create\-signer\-cert(1)\fP, \fBoc\-adm\-config(1)\fP, \fBoc\-adm\-completion(1)\fP, \fBoc\-adm\-options(1)\fP, +\fBoc(1)\fP, \fBoc\-adm\-router(1)\fP, \fBoc\-adm\-ipfailover(1)\fP, \fBoc\-adm\-registry(1)\fP, \fBoc\-adm\-new\-project(1)\fP, \fBoc\-adm\-policy(1)\fP, \fBoc\-adm\-groups(1)\fP, \fBoc\-adm\-ca(1)\fP, \fBoc\-adm\-overwrite\-policy(1)\fP, \fBoc\-adm\-create\-node\-config(1)\fP, \fBoc\-adm\-manage\-node(1)\fP, \fBoc\-adm\-cordon(1)\fP, \fBoc\-adm\-uncordon(1)\fP, \fBoc\-adm\-drain(1)\fP, \fBoc\-adm\-taint(1)\fP, \fBoc\-adm\-pod\-network(1)\fP, \fBoc\-adm\-diagnostics(1)\fP, \fBoc\-adm\-prune(1)\fP, \fBoc\-adm\-build\-chain(1)\fP, \fBoc\-adm\-migrate(1)\fP, \fBoc\-adm\-create\-kubeconfig(1)\fP, \fBoc\-adm\-create\-api\-client\-config(1)\fP, \fBoc\-adm\-create\-bootstrap\-project\-template(1)\fP, \fBoc\-adm\-create\-bootstrap\-policy\-file(1)\fP, \fBoc\-adm\-create\-login\-template(1)\fP, \fBoc\-adm\-create\-provider\-selection\-template(1)\fP, \fBoc\-adm\-create\-error\-template(1)\fP, \fBoc\-adm\-create\-master\-certs(1)\fP, \fBoc\-adm\-create\-key\-pair(1)\fP, \fBoc\-adm\-create\-server\-cert(1)\fP, \fBoc\-adm\-create\-signer\-cert(1)\fP, \fBoc\-adm\-config(1)\fP, \fBoc\-adm\-completion(1)\fP, \fBoc\-adm\-options(1)\fP, .SH HISTORY diff --git a/docs/man/man1/openshift-admin-migrate-image-references.1 b/docs/man/man1/openshift-admin-migrate-image-references.1 new file mode 100644 index 000000000000..b142bede6193 --- /dev/null +++ b/docs/man/man1/openshift-admin-migrate-image-references.1 @@ -0,0 +1,176 @@ +.TH "OPENSHIFT ADMIN MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +openshift admin migrate image\-references \- Update embedded Docker image references + + +.SH SYNOPSIS +.PP +\fBopenshift admin migrate image\-references\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.PP +The following resource types may be migrated by this command: +.IP + +.IP +\(bu images * daemonsets +.IP +\(bu imagestreams * jobs +.IP +\(bu buildconfigs * replicationcontrollers +.IP +\(bu deploymentconfigs * pods +.IP +\(bu secrets (docker) +.PP +Only images, imagestreams, and secrets are updated by default. Updating images and image +streams requires administrative privileges. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[imagestream,image,secrets] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBopenshift\-admin\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/openshift-admin-migrate-storage.1 b/docs/man/man1/openshift-admin-migrate-storage.1 new file mode 100644 index 000000000000..8102962ea6cb --- /dev/null +++ b/docs/man/man1/openshift-admin-migrate-storage.1 @@ -0,0 +1,165 @@ +.TH "OPENSHIFT ADMIN MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +openshift admin migrate storage \- Update the stored version of API objects + + +.SH SYNOPSIS +.PP +\fBopenshift admin migrate storage\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.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 + +.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. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[*] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + + +.SH SEE ALSO +.PP +\fBopenshift\-admin\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/openshift-admin-migrate.1 b/docs/man/man1/openshift-admin-migrate.1 new file mode 100644 index 000000000000..3374dd356005 --- /dev/null +++ b/docs/man/man1/openshift-admin-migrate.1 @@ -0,0 +1,95 @@ +.TH "OPENSHIFT ADMIN" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +openshift admin migrate \- Migrate data in the cluster + + +.SH SYNOPSIS +.PP +\fBopenshift admin migrate\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +Migrate resources on the cluster + +.PP +These commands assist administrators in performing preventative maintenance on a cluster. + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH SEE ALSO +.PP +\fBopenshift\-admin(1)\fP, \fBopenshift\-admin\-migrate\-image\-references(1)\fP, \fBopenshift\-admin\-migrate\-storage(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/openshift-admin.1 b/docs/man/man1/openshift-admin.1 index 9950efeeff7c..0747d74a4a46 100644 --- a/docs/man/man1/openshift-admin.1 +++ b/docs/man/man1/openshift-admin.1 @@ -90,7 +90,7 @@ actions involve interaction with the command\-line client as well. .SH SEE ALSO .PP -\fBopenshift(1)\fP, \fBopenshift\-admin\-router(1)\fP, \fBopenshift\-admin\-ipfailover(1)\fP, \fBopenshift\-admin\-registry(1)\fP, \fBopenshift\-admin\-new\-project(1)\fP, \fBopenshift\-admin\-policy(1)\fP, \fBopenshift\-admin\-groups(1)\fP, \fBopenshift\-admin\-ca(1)\fP, \fBopenshift\-admin\-overwrite\-policy(1)\fP, \fBopenshift\-admin\-create\-node\-config(1)\fP, \fBopenshift\-admin\-manage\-node(1)\fP, \fBopenshift\-admin\-cordon(1)\fP, \fBopenshift\-admin\-uncordon(1)\fP, \fBopenshift\-admin\-drain(1)\fP, \fBopenshift\-admin\-taint(1)\fP, \fBopenshift\-admin\-pod\-network(1)\fP, \fBopenshift\-admin\-diagnostics(1)\fP, \fBopenshift\-admin\-prune(1)\fP, \fBopenshift\-admin\-build\-chain(1)\fP, \fBopenshift\-admin\-create\-kubeconfig(1)\fP, \fBopenshift\-admin\-create\-api\-client\-config(1)\fP, \fBopenshift\-admin\-create\-bootstrap\-project\-template(1)\fP, \fBopenshift\-admin\-create\-bootstrap\-policy\-file(1)\fP, \fBopenshift\-admin\-create\-login\-template(1)\fP, \fBopenshift\-admin\-create\-provider\-selection\-template(1)\fP, \fBopenshift\-admin\-create\-error\-template(1)\fP, \fBopenshift\-admin\-create\-master\-certs(1)\fP, \fBopenshift\-admin\-create\-key\-pair(1)\fP, \fBopenshift\-admin\-create\-server\-cert(1)\fP, \fBopenshift\-admin\-create\-signer\-cert(1)\fP, \fBopenshift\-admin\-config(1)\fP, \fBopenshift\-admin\-completion(1)\fP, \fBopenshift\-admin\-options(1)\fP, +\fBopenshift(1)\fP, \fBopenshift\-admin\-router(1)\fP, \fBopenshift\-admin\-ipfailover(1)\fP, \fBopenshift\-admin\-registry(1)\fP, \fBopenshift\-admin\-new\-project(1)\fP, \fBopenshift\-admin\-policy(1)\fP, \fBopenshift\-admin\-groups(1)\fP, \fBopenshift\-admin\-ca(1)\fP, \fBopenshift\-admin\-overwrite\-policy(1)\fP, \fBopenshift\-admin\-create\-node\-config(1)\fP, \fBopenshift\-admin\-manage\-node(1)\fP, \fBopenshift\-admin\-cordon(1)\fP, \fBopenshift\-admin\-uncordon(1)\fP, \fBopenshift\-admin\-drain(1)\fP, \fBopenshift\-admin\-taint(1)\fP, \fBopenshift\-admin\-pod\-network(1)\fP, \fBopenshift\-admin\-diagnostics(1)\fP, \fBopenshift\-admin\-prune(1)\fP, \fBopenshift\-admin\-build\-chain(1)\fP, \fBopenshift\-admin\-migrate(1)\fP, \fBopenshift\-admin\-create\-kubeconfig(1)\fP, \fBopenshift\-admin\-create\-api\-client\-config(1)\fP, \fBopenshift\-admin\-create\-bootstrap\-project\-template(1)\fP, \fBopenshift\-admin\-create\-bootstrap\-policy\-file(1)\fP, \fBopenshift\-admin\-create\-login\-template(1)\fP, \fBopenshift\-admin\-create\-provider\-selection\-template(1)\fP, \fBopenshift\-admin\-create\-error\-template(1)\fP, \fBopenshift\-admin\-create\-master\-certs(1)\fP, \fBopenshift\-admin\-create\-key\-pair(1)\fP, \fBopenshift\-admin\-create\-server\-cert(1)\fP, \fBopenshift\-admin\-create\-signer\-cert(1)\fP, \fBopenshift\-admin\-config(1)\fP, \fBopenshift\-admin\-completion(1)\fP, \fBopenshift\-admin\-options(1)\fP, .SH HISTORY diff --git a/docs/man/man1/openshift-cli-adm-migrate-image-references.1 b/docs/man/man1/openshift-cli-adm-migrate-image-references.1 new file mode 100644 index 000000000000..fca7dd6daaaf --- /dev/null +++ b/docs/man/man1/openshift-cli-adm-migrate-image-references.1 @@ -0,0 +1,176 @@ +.TH "OPENSHIFT CLI ADM MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +openshift cli adm migrate image\-references \- Update embedded Docker image references + + +.SH SYNOPSIS +.PP +\fBopenshift cli adm migrate image\-references\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.PP +The following resource types may be migrated by this command: +.IP + +.IP +\(bu images * daemonsets +.IP +\(bu imagestreams * jobs +.IP +\(bu buildconfigs * replicationcontrollers +.IP +\(bu deploymentconfigs * pods +.IP +\(bu secrets (docker) +.PP +Only images, imagestreams, and secrets are updated by default. Updating images and image +streams requires administrative privileges. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[imagestream,image,secrets] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBopenshift\-cli\-adm\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/openshift-cli-adm-migrate-storage.1 b/docs/man/man1/openshift-cli-adm-migrate-storage.1 new file mode 100644 index 000000000000..d0c34d7c94b1 --- /dev/null +++ b/docs/man/man1/openshift-cli-adm-migrate-storage.1 @@ -0,0 +1,165 @@ +.TH "OPENSHIFT CLI ADM MIGRATE" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +openshift cli adm migrate storage \- Update the stored version of API objects + + +.SH SYNOPSIS +.PP +\fBopenshift cli adm migrate storage\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +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). + +.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. + +.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 + +.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. + + +.SH OPTIONS +.PP +\fB\-\-all\-namespaces\fP=true + Migrate objects in all namespaces. Defaults to true. + +.PP +\fB\-\-confirm\fP=false + If true, all requested objects will be migrated. Defaults to false. + +.PP +\fB\-f\fP, \fB\-\-filename\fP=[] + Filename, directory, or URL to docker\-compose.yml file to use + +.PP +\fB\-\-from\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) greater than or equal to this value + +.PP +\fB\-\-include\fP=[*] + Resource types to migrate. Passing \-\-filename will override this flag. + +.PP +\fB\-o\fP, \fB\-\-output\fP="" + Output the modified objects instead of saving them, valid values are 'yaml' or 'json' + +.PP +\fB\-\-to\-key\fP="" + If specified, only migrate items with a key (namespace/name or name) less than this value + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH EXAMPLE +.PP +.RS + +.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 + + +.SH SEE ALSO +.PP +\fBopenshift\-cli\-adm\-migrate(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/openshift-cli-adm-migrate.1 b/docs/man/man1/openshift-cli-adm-migrate.1 new file mode 100644 index 000000000000..bf88e88526d3 --- /dev/null +++ b/docs/man/man1/openshift-cli-adm-migrate.1 @@ -0,0 +1,95 @@ +.TH "OPENSHIFT CLI ADM" "1" " Openshift CLI User Manuals" "Openshift" "June 2016" "" + + +.SH NAME +.PP +openshift cli adm migrate \- Migrate data in the cluster + + +.SH SYNOPSIS +.PP +\fBopenshift cli adm migrate\fP [OPTIONS] + + +.SH DESCRIPTION +.PP +Migrate resources on the cluster + +.PP +These commands assist administrators in performing preventative maintenance on a cluster. + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.PP +\fB\-\-api\-version\fP="" + DEPRECATED: The API version to use when talking to the server + +.PP +\fB\-\-as\fP="" + Username to impersonate for the operation. + +.PP +\fB\-\-certificate\-authority\fP="" + Path to a cert. file for the certificate authority. + +.PP +\fB\-\-client\-certificate\fP="" + Path to a client certificate file for TLS. + +.PP +\fB\-\-client\-key\fP="" + Path to a client key file for TLS. + +.PP +\fB\-\-cluster\fP="" + The name of the kubeconfig cluster to use + +.PP +\fB\-\-config\fP="" + Path to the config file to use for CLI requests. + +.PP +\fB\-\-context\fP="" + The name of the kubeconfig context to use + +.PP +\fB\-\-google\-json\-key\fP="" + The Google Cloud Platform Service Account JSON Key to use for authentication. + +.PP +\fB\-\-insecure\-skip\-tls\-verify\fP=false + If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + +.PP +\fB\-\-log\-flush\-frequency\fP=0 + Maximum number of seconds between log flushes + +.PP +\fB\-\-match\-server\-version\fP=false + Require server version to match client version + +.PP +\fB\-n\fP, \fB\-\-namespace\fP="" + If present, the namespace scope for this CLI request. + +.PP +\fB\-\-server\fP="" + The address and port of the Kubernetes API server + +.PP +\fB\-\-token\fP="" + Bearer token for authentication to the API server. + +.PP +\fB\-\-user\fP="" + The name of the kubeconfig user to use + + +.SH SEE ALSO +.PP +\fBopenshift\-cli\-adm(1)\fP, \fBopenshift\-cli\-adm\-migrate\-image\-references(1)\fP, \fBopenshift\-cli\-adm\-migrate\-storage(1)\fP, + + +.SH HISTORY +.PP +June 2016, Ported from the Kubernetes man\-doc generator diff --git a/docs/man/man1/openshift-cli-adm.1 b/docs/man/man1/openshift-cli-adm.1 index a263f7114ede..750d1b5054ad 100644 --- a/docs/man/man1/openshift-cli-adm.1 +++ b/docs/man/man1/openshift-cli-adm.1 @@ -90,7 +90,7 @@ actions involve interaction with the command\-line client as well. .SH SEE ALSO .PP -\fBopenshift\-cli(1)\fP, \fBopenshift\-cli\-adm\-router(1)\fP, \fBopenshift\-cli\-adm\-ipfailover(1)\fP, \fBopenshift\-cli\-adm\-registry(1)\fP, \fBopenshift\-cli\-adm\-new\-project(1)\fP, \fBopenshift\-cli\-adm\-policy(1)\fP, \fBopenshift\-cli\-adm\-groups(1)\fP, \fBopenshift\-cli\-adm\-ca(1)\fP, \fBopenshift\-cli\-adm\-overwrite\-policy(1)\fP, \fBopenshift\-cli\-adm\-create\-node\-config(1)\fP, \fBopenshift\-cli\-adm\-manage\-node(1)\fP, \fBopenshift\-cli\-adm\-cordon(1)\fP, \fBopenshift\-cli\-adm\-uncordon(1)\fP, \fBopenshift\-cli\-adm\-drain(1)\fP, \fBopenshift\-cli\-adm\-taint(1)\fP, \fBopenshift\-cli\-adm\-pod\-network(1)\fP, \fBopenshift\-cli\-adm\-diagnostics(1)\fP, \fBopenshift\-cli\-adm\-prune(1)\fP, \fBopenshift\-cli\-adm\-build\-chain(1)\fP, \fBopenshift\-cli\-adm\-create\-kubeconfig(1)\fP, \fBopenshift\-cli\-adm\-create\-api\-client\-config(1)\fP, \fBopenshift\-cli\-adm\-create\-bootstrap\-project\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-bootstrap\-policy\-file(1)\fP, \fBopenshift\-cli\-adm\-create\-login\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-provider\-selection\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-error\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-master\-certs(1)\fP, \fBopenshift\-cli\-adm\-create\-key\-pair(1)\fP, \fBopenshift\-cli\-adm\-create\-server\-cert(1)\fP, \fBopenshift\-cli\-adm\-create\-signer\-cert(1)\fP, \fBopenshift\-cli\-adm\-config(1)\fP, \fBopenshift\-cli\-adm\-completion(1)\fP, \fBopenshift\-cli\-adm\-options(1)\fP, +\fBopenshift\-cli(1)\fP, \fBopenshift\-cli\-adm\-router(1)\fP, \fBopenshift\-cli\-adm\-ipfailover(1)\fP, \fBopenshift\-cli\-adm\-registry(1)\fP, \fBopenshift\-cli\-adm\-new\-project(1)\fP, \fBopenshift\-cli\-adm\-policy(1)\fP, \fBopenshift\-cli\-adm\-groups(1)\fP, \fBopenshift\-cli\-adm\-ca(1)\fP, \fBopenshift\-cli\-adm\-overwrite\-policy(1)\fP, \fBopenshift\-cli\-adm\-create\-node\-config(1)\fP, \fBopenshift\-cli\-adm\-manage\-node(1)\fP, \fBopenshift\-cli\-adm\-cordon(1)\fP, \fBopenshift\-cli\-adm\-uncordon(1)\fP, \fBopenshift\-cli\-adm\-drain(1)\fP, \fBopenshift\-cli\-adm\-taint(1)\fP, \fBopenshift\-cli\-adm\-pod\-network(1)\fP, \fBopenshift\-cli\-adm\-diagnostics(1)\fP, \fBopenshift\-cli\-adm\-prune(1)\fP, \fBopenshift\-cli\-adm\-build\-chain(1)\fP, \fBopenshift\-cli\-adm\-migrate(1)\fP, \fBopenshift\-cli\-adm\-create\-kubeconfig(1)\fP, \fBopenshift\-cli\-adm\-create\-api\-client\-config(1)\fP, \fBopenshift\-cli\-adm\-create\-bootstrap\-project\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-bootstrap\-policy\-file(1)\fP, \fBopenshift\-cli\-adm\-create\-login\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-provider\-selection\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-error\-template(1)\fP, \fBopenshift\-cli\-adm\-create\-master\-certs(1)\fP, \fBopenshift\-cli\-adm\-create\-key\-pair(1)\fP, \fBopenshift\-cli\-adm\-create\-server\-cert(1)\fP, \fBopenshift\-cli\-adm\-create\-signer\-cert(1)\fP, \fBopenshift\-cli\-adm\-config(1)\fP, \fBopenshift\-cli\-adm\-completion(1)\fP, \fBopenshift\-cli\-adm\-options(1)\fP, .SH HISTORY