Merge pull request #24 from jrha/24.10.0

Update documentation from 24.10.0
quattor · Nov 26, 2024 · 736d569 · 736d569
2 parents 1e973a5 + 169f507
commit 736d569
Show file tree

Hide file tree

Showing 122 changed files with 13,330 additions and 3,474 deletions.
diff --git a/docs/components-grid/NCM_Component_pbsclient.rst b/docs/components-grid/NCM_Component_pbsclient.rst
@@ -195,4 +195,3 @@ RESOURCES
 
  If true, it assumes this host is only used for job submission, and has no pbs MOM running
   that requires restarting.
-
diff --git a/docs/components/NCM_Component_Ceph_Octopus.rst b/docs/components/NCM_Component_Ceph_Octopus.rst
@@ -0,0 +1,96 @@
+
+################################
+NCM\::Component\::Ceph\::Octopus
+################################
+
+
+****
+NAME
+****
+
+
+ncm-ceph: Configuration module for CEPH
+
+
+***********
+DESCRIPTION
+***********
+
+
+Configuration module for CEPH
+This is the module for Ceph versions > 15.2.0 and schema version v2 with orchestrator
+
+
+********************
+IMPLEMENTED FEATURES
+********************
+
+
+Features that are implemented at this moment:
+
+
+* Generating orchestrator yaml files and management of existing cluster (bootstrap not implemented)
+
+
+
+* Configuration file generation
+
+
+
+* All daemons should already be adopted for cephadm, and ceph orchestrator should be configured.         This is either part of the adoption process https://docs.ceph.com/en/latest/cephadm/adoption/
+        or by bootstraping a new cluster (see initial creation)
+
+
+
+
+****************
+INITIAL CREATION
+****************
+
+
+- The schema details are annotated in the schema file.
+
+- Example pan files are included in the examples folder and also in the test folders.
+
+To set up the initial cluster, some steps should be taken:
+
+
+1. The mgr(s) should have passwordless ssh access to all the hosts of the cluster         e.g. by distributing the public key(s) of the ceph-deploy host(s) over the cluster hosts
+            (As described in the cephadm documentation:
+                        https://docs.ceph.com/en/latest/cephadm/install/#add-hosts-to-the-cluster)
+
+
+
+- 2. Run the bootstrap command:         See https://docs.ceph.com/en/latest/cephadm/install/#bootstrap-a-new-cluster
+
+
+
+- 3. You'll need the generated pubkey and admin keyring to distribute over cluster
+
+
+
+- 4. Run the component to start the configuration of the new cluster
+
+
+
+
+*********
+RESOURCES
+*********
+
+
+`/software/components/ceph`
+===========================
+
+
+The configuration information for the component.  Each field should
+be described in this section.
+
+
+
+************
+DEPENDENCIES
+************
+
+
+The component is tested with Ceph version 15.2.8
diff --git a/docs/components/NCM_Component_OpenStack_Barbican.rst b/docs/components/NCM_Component_OpenStack_Barbican.rst
diff --git a/docs/components/NCM_Component_OpenStack_Ceilometer.rst b/docs/components/NCM_Component_OpenStack_Ceilometer.rst
diff --git a/docs/components/NCM_Component_OpenStack_Cinder.rst b/docs/components/NCM_Component_OpenStack_Cinder.rst
diff --git a/docs/components/NCM_Component_OpenStack_Client.rst b/docs/components/NCM_Component_OpenStack_Client.rst
diff --git a/docs/components/NCM_Component_OpenStack_Cloudkitty.rst b/docs/components/NCM_Component_OpenStack_Cloudkitty.rst
diff --git a/docs/components/NCM_Component_OpenStack_Glance.rst b/docs/components/NCM_Component_OpenStack_Glance.rst
diff --git a/docs/components/NCM_Component_OpenStack_Heat.rst b/docs/components/NCM_Component_OpenStack_Heat.rst
diff --git a/docs/components/NCM_Component_OpenStack_Horizon.rst b/docs/components/NCM_Component_OpenStack_Horizon.rst
diff --git a/docs/components/NCM_Component_OpenStack_Identity.rst b/docs/components/NCM_Component_OpenStack_Identity.rst
diff --git a/docs/components/NCM_Component_OpenStack_Keystone.rst b/docs/components/NCM_Component_OpenStack_Keystone.rst
diff --git a/docs/components/NCM_Component_OpenStack_Logger.rst b/docs/components/NCM_Component_OpenStack_Logger.rst
diff --git a/docs/components/NCM_Component_OpenStack_Magnum.rst b/docs/components/NCM_Component_OpenStack_Magnum.rst
diff --git a/docs/components/NCM_Component_OpenStack_Manila.rst b/docs/components/NCM_Component_OpenStack_Manila.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -195,4 +195,3 @@ RESOURCES

		If true, it assumes this host is only used for job submission, and has no pbs MOM running
		that requires restarting.