diff --git a/doc/common/chapter00.rst b/doc/common/chapter00.rst index cb7f32fe99..79b3f13464 100644 --- a/doc/common/chapter00.rst +++ b/doc/common/chapter00.rst @@ -131,7 +131,7 @@ Architectural Principles Following are a number of key architectural principles that apply to all Reference Architectures produced by the Anuket project: 1. **Open-source preference:** for building Cloud Infrastructure - solutions, components and tools, using open-source technology. + solutions, components, and tools. 2. **Open APIs:** to enable interoperability, component substitution, and minimise integration efforts. 3. **Separation of concerns:** to promote lifecycle independence of diff --git a/doc/gov/README.rst b/doc/gov/README.rst deleted file mode 120000 index 4a5794469a..0000000000 --- a/doc/gov/README.rst +++ /dev/null @@ -1 +0,0 @@ -index.rst \ No newline at end of file diff --git a/doc/gov/README.rst b/doc/gov/README.rst new file mode 100644 index 0000000000..52c371c0f1 --- /dev/null +++ b/doc/gov/README.rst @@ -0,0 +1,14 @@ +========================================================== +Community Guidelines for Anuket Specifications Development +========================================================== + +Table of contents +----------------- + +.. toctree:: + :numbered: + :maxdepth: 1 + + chapters/chapter01 + chapters/chapter09 + diff --git a/doc/gov/index.rst b/doc/gov/index.rst deleted file mode 100644 index cdbe6514ee..0000000000 --- a/doc/gov/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -Anuket Project - Community Guidelines -===================================== - -Table of contents ------------------ - -.. toctree:: - :maxdepth: 1 - - chapters/chapter01 - chapters/chapter09 diff --git a/doc/gov/index.rst b/doc/gov/index.rst new file mode 120000 index 0000000000..92cacd2853 --- /dev/null +++ b/doc/gov/index.rst @@ -0,0 +1 @@ +README.rst \ No newline at end of file diff --git a/doc/ref_arch/kubernetes/chapters/chapter03.rst b/doc/ref_arch/kubernetes/chapters/chapter03.rst index 10e189ed4a..a77739fbdd 100644 --- a/doc/ref_arch/kubernetes/chapters/chapter03.rst +++ b/doc/ref_arch/kubernetes/chapters/chapter03.rst @@ -5,7 +5,7 @@ Introduction ------------ The Anuket Reference Architecture (RA2) for Kubernetes based cloud infrastructure is intended to be an industry -standard-independent Kubernetes reference architecture that is not tied to any specific offering or distribution. +standard-independent Kubernetes reference architecture that is not tied to any specific offering or distribution. No vendor-specific enhancements are required to achieve conformance with the Anuket specifications. Conformance to these specifications can be achieved by using upstream components or features that are developed by the open source community, and conformance is ensured by successfully running the RC2 conformance testing suite. @@ -13,7 +13,7 @@ open source community, and conformance is ensured by successfully running the RC By using the Reference Architecture (RA2) for Kubernetes based cloud infrastructure specifications, operators can deploy infrastructure that will run any VNF or CNF that has successfully run on an RA2-conformant infrastructure. The purpose of this chapter is to outline all the components required to provide Telco-grade Kubernetes in a consistent and -reliable way. The specification of how to setup these components is detailed in +reliable way. The specification of how to setup these components is detailed in :ref:`Chapter 04`. Kubernetes is already a well-documented and widely deployed open source project of the Cloud Native diff --git a/doc/ref_arch/kubernetes/chapters/chapter04.rst b/doc/ref_arch/kubernetes/chapters/chapter04.rst index 845f6cb1ba..f695d91be7 100644 --- a/doc/ref_arch/kubernetes/chapters/chapter04.rst +++ b/doc/ref_arch/kubernetes/chapters/chapter04.rst @@ -111,7 +111,7 @@ the following specifications: - :ref:`RI2 Infrastructure Requirements ` * - ra2.ch.011 - Virtual Node CPU Quantity - - If using VMs, the Kubernetes Nodes must be equipped with at least 16 vCPUs. + - If using VMs, the Kubernetes Nodes must be equipped with at least 16 vCPUs. .. note:: @@ -124,7 +124,7 @@ the following specifications: * - ra2.ch.012 - Kubernetes Node RAM Quantity - The Kubernetes Nodes must be equipped with at least 32GB of RAM. - + .. note:: Note, extra RAM capacity should be provisioned to cater for @@ -319,7 +319,7 @@ the following specifications: - * - ra2.k8s.007 - DevicePlugins Feature Gate - - When hosting workloads matching the High Performance profile, the DevicePlugins feature gate must be enabled. + - When hosting workloads matching the High Performance profile, the DevicePlugins feature gate must be enabled. --feature-gates="...,DevicePlugins=true,..." .. note:: diff --git a/doc/ref_arch/kubernetes/chapters/chapter06.rst b/doc/ref_arch/kubernetes/chapters/chapter06.rst index f128284677..22907bc6aa 100644 --- a/doc/ref_arch/kubernetes/chapters/chapter06.rst +++ b/doc/ref_arch/kubernetes/chapters/chapter06.rst @@ -25,7 +25,7 @@ A feature can be in Alpha, Beta or GA stage: - Alpha features are disabled by default, may be buggy, and support may be dropped - Beta features are disabled by default, are well tested, and support will not be dropped (although breaking API changes may happen). Any existing Beta feature as of 1.24 will continue to be enabled by default, but new beta APIs - and features will not be enabled by default after Kubernetes 1.24. + and features will not be enabled by default after Kubernetes 1.24. More in `KEP-3136 `__ - GA features are stable, always enabled and cannot be disabled.