From 1585d2ecb5b48652c3ae9b61d0d66b97f1ff1e9e Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Tue, 3 Aug 2021 08:30:28 -0400 Subject: [PATCH] Apply dir convention to Admintasks Moved all Kubernetes admintasks content under a kubernetes directory. This is needed to allow title versioning distinctions in partner builds Signed-off-by: Ron Stone Change-Id: I38b9b0bc01096f8ef513dad15daff2add2a812a8 --- doc/source/admintasks/index.rst | 72 +++++-------------- .../about-the-admin-tutorials.rst | 0 ...pplication-commands-and-helm-overrides.rst | 0 ...ing-space-in-the-local-docker-registry.rst | 0 doc/source/admintasks/kubernetes/index.rst | 62 ++++++++++++++++ ...and-running-cpu-manager-for-kubernetes.rst | 0 ...dating-the-docker-registry-certificate.rst | 0 ...res-to-enhance-application-performance.rst | 0 ...rials-authentication-and-authorization.rst | 0 ...s-admin-tutorials-helm-package-manager.rst | 0 ...ernetes-admin-tutorials-metrics-server.rst | 0 ...-starlingx-application-package-manager.rst | 0 .../kubernetes-cpu-manager-policies.rst | 0 .../kubernetes-topology-manager-policies.rst | 0 .../local-docker-registry.rst | 0 .../setting-up-a-public-repository.rst | 0 16 files changed, 78 insertions(+), 56 deletions(-) rename doc/source/admintasks/{ => kubernetes}/about-the-admin-tutorials.rst (100%) rename doc/source/admintasks/{ => kubernetes}/admin-application-commands-and-helm-overrides.rst (100%) rename doc/source/admintasks/{ => kubernetes}/freeing-space-in-the-local-docker-registry.rst (100%) create mode 100644 doc/source/admintasks/kubernetes/index.rst rename doc/source/admintasks/{ => kubernetes}/installing-and-running-cpu-manager-for-kubernetes.rst (100%) rename doc/source/admintasks/{ => kubernetes}/installing-updating-the-docker-registry-certificate.rst (100%) rename doc/source/admintasks/{ => kubernetes}/isolating-cpu-cores-to-enhance-application-performance.rst (100%) rename doc/source/admintasks/{ => kubernetes}/kubernetes-admin-tutorials-authentication-and-authorization.rst (100%) rename doc/source/admintasks/{ => kubernetes}/kubernetes-admin-tutorials-helm-package-manager.rst (100%) rename doc/source/admintasks/{ => kubernetes}/kubernetes-admin-tutorials-metrics-server.rst (100%) rename doc/source/admintasks/{ => kubernetes}/kubernetes-admin-tutorials-starlingx-application-package-manager.rst (100%) rename doc/source/admintasks/{ => kubernetes}/kubernetes-cpu-manager-policies.rst (100%) rename doc/source/admintasks/{ => kubernetes}/kubernetes-topology-manager-policies.rst (100%) rename doc/source/admintasks/{ => kubernetes}/local-docker-registry.rst (100%) rename doc/source/admintasks/{ => kubernetes}/setting-up-a-public-repository.rst (100%) diff --git a/doc/source/admintasks/index.rst b/doc/source/admintasks/index.rst index 99378a8eb..4809f5e8e 100644 --- a/doc/source/admintasks/index.rst +++ b/doc/source/admintasks/index.rst @@ -1,70 +1,30 @@ -.. _admin-tasks-title: - +.. _admintasks-index: =========== Admin Tasks =========== --------------------- -StarlingX Kubernetes --------------------- +The |prod-long| Kubernetes administration tutorials provide working examples +of common administrative tasks. + +---------- +Kubernetes +---------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - about-the-admin-tutorials - installing-and-running-cpu-manager-for-kubernetes - ----------------------- -Application management ----------------------- - -.. toctree:: - :maxdepth: 1 - - kubernetes-admin-tutorials-helm-package-manager - kubernetes-admin-tutorials-starlingx-application-package-manager - admin-application-commands-and-helm-overrides - ---------------------- -Local Docker registry ---------------------- - -.. toctree:: - :maxdepth: 1 - - local-docker-registry - kubernetes-admin-tutorials-authentication-and-authorization - installing-updating-the-docker-registry-certificate - setting-up-a-public-repository - freeing-space-in-the-local-docker-registry - --------------------------------- -Optimize application performance --------------------------------- - -.. toctree:: - :maxdepth: 1 - - kubernetes-cpu-manager-policies - isolating-cpu-cores-to-enhance-application-performance - kubernetes-topology-manager-policies - - --------------- -Metrics Server --------------- - -.. toctree:: - :maxdepth: 1 - - kubernetes-admin-tutorials-metrics-server + kubernetes/index ------------------- StarlingX OpenStack ------------------- -.. toctree:: - :maxdepth: 2 +|prod| supports configuring Nova's dedicated and shared CPU pools on a per +openstack-compute host basis. - openstack/index \ No newline at end of file + +.. toctree:: + :maxdepth: 2 + + openstack/index \ No newline at end of file diff --git a/doc/source/admintasks/about-the-admin-tutorials.rst b/doc/source/admintasks/kubernetes/about-the-admin-tutorials.rst similarity index 100% rename from doc/source/admintasks/about-the-admin-tutorials.rst rename to doc/source/admintasks/kubernetes/about-the-admin-tutorials.rst diff --git a/doc/source/admintasks/admin-application-commands-and-helm-overrides.rst b/doc/source/admintasks/kubernetes/admin-application-commands-and-helm-overrides.rst similarity index 100% rename from doc/source/admintasks/admin-application-commands-and-helm-overrides.rst rename to doc/source/admintasks/kubernetes/admin-application-commands-and-helm-overrides.rst diff --git a/doc/source/admintasks/freeing-space-in-the-local-docker-registry.rst b/doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst similarity index 100% rename from doc/source/admintasks/freeing-space-in-the-local-docker-registry.rst rename to doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst diff --git a/doc/source/admintasks/kubernetes/index.rst b/doc/source/admintasks/kubernetes/index.rst new file mode 100644 index 000000000..127d0c9d2 --- /dev/null +++ b/doc/source/admintasks/kubernetes/index.rst @@ -0,0 +1,62 @@ +.. _admin-tasks-title: + + +======== +Contents +======== + +-------------------- +StarlingX Kubernetes +-------------------- + +.. toctree:: + :maxdepth: 1 + + about-the-admin-tutorials + installing-and-running-cpu-manager-for-kubernetes + +---------------------- +Application management +---------------------- + +.. toctree:: + :maxdepth: 1 + + kubernetes-admin-tutorials-helm-package-manager + kubernetes-admin-tutorials-starlingx-application-package-manager + admin-application-commands-and-helm-overrides + +--------------------- +Local Docker registry +--------------------- + +.. toctree:: + :maxdepth: 1 + + local-docker-registry + kubernetes-admin-tutorials-authentication-and-authorization + installing-updating-the-docker-registry-certificate + setting-up-a-public-repository + freeing-space-in-the-local-docker-registry + +-------------------------------- +Optimize application performance +-------------------------------- + +.. toctree:: + :maxdepth: 1 + + kubernetes-cpu-manager-policies + isolating-cpu-cores-to-enhance-application-performance + kubernetes-topology-manager-policies + + +-------------- +Metrics Server +-------------- + +.. toctree:: + :maxdepth: 1 + + kubernetes-admin-tutorials-metrics-server + diff --git a/doc/source/admintasks/installing-and-running-cpu-manager-for-kubernetes.rst b/doc/source/admintasks/kubernetes/installing-and-running-cpu-manager-for-kubernetes.rst similarity index 100% rename from doc/source/admintasks/installing-and-running-cpu-manager-for-kubernetes.rst rename to doc/source/admintasks/kubernetes/installing-and-running-cpu-manager-for-kubernetes.rst diff --git a/doc/source/admintasks/installing-updating-the-docker-registry-certificate.rst b/doc/source/admintasks/kubernetes/installing-updating-the-docker-registry-certificate.rst similarity index 100% rename from doc/source/admintasks/installing-updating-the-docker-registry-certificate.rst rename to doc/source/admintasks/kubernetes/installing-updating-the-docker-registry-certificate.rst diff --git a/doc/source/admintasks/isolating-cpu-cores-to-enhance-application-performance.rst b/doc/source/admintasks/kubernetes/isolating-cpu-cores-to-enhance-application-performance.rst similarity index 100% rename from doc/source/admintasks/isolating-cpu-cores-to-enhance-application-performance.rst rename to doc/source/admintasks/kubernetes/isolating-cpu-cores-to-enhance-application-performance.rst diff --git a/doc/source/admintasks/kubernetes-admin-tutorials-authentication-and-authorization.rst b/doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-authentication-and-authorization.rst similarity index 100% rename from doc/source/admintasks/kubernetes-admin-tutorials-authentication-and-authorization.rst rename to doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-authentication-and-authorization.rst diff --git a/doc/source/admintasks/kubernetes-admin-tutorials-helm-package-manager.rst b/doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-helm-package-manager.rst similarity index 100% rename from doc/source/admintasks/kubernetes-admin-tutorials-helm-package-manager.rst rename to doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-helm-package-manager.rst diff --git a/doc/source/admintasks/kubernetes-admin-tutorials-metrics-server.rst b/doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-metrics-server.rst similarity index 100% rename from doc/source/admintasks/kubernetes-admin-tutorials-metrics-server.rst rename to doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-metrics-server.rst diff --git a/doc/source/admintasks/kubernetes-admin-tutorials-starlingx-application-package-manager.rst b/doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-starlingx-application-package-manager.rst similarity index 100% rename from doc/source/admintasks/kubernetes-admin-tutorials-starlingx-application-package-manager.rst rename to doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-starlingx-application-package-manager.rst diff --git a/doc/source/admintasks/kubernetes-cpu-manager-policies.rst b/doc/source/admintasks/kubernetes/kubernetes-cpu-manager-policies.rst similarity index 100% rename from doc/source/admintasks/kubernetes-cpu-manager-policies.rst rename to doc/source/admintasks/kubernetes/kubernetes-cpu-manager-policies.rst diff --git a/doc/source/admintasks/kubernetes-topology-manager-policies.rst b/doc/source/admintasks/kubernetes/kubernetes-topology-manager-policies.rst similarity index 100% rename from doc/source/admintasks/kubernetes-topology-manager-policies.rst rename to doc/source/admintasks/kubernetes/kubernetes-topology-manager-policies.rst diff --git a/doc/source/admintasks/local-docker-registry.rst b/doc/source/admintasks/kubernetes/local-docker-registry.rst similarity index 100% rename from doc/source/admintasks/local-docker-registry.rst rename to doc/source/admintasks/kubernetes/local-docker-registry.rst diff --git a/doc/source/admintasks/setting-up-a-public-repository.rst b/doc/source/admintasks/kubernetes/setting-up-a-public-repository.rst similarity index 100% rename from doc/source/admintasks/setting-up-a-public-repository.rst rename to doc/source/admintasks/kubernetes/setting-up-a-public-repository.rst