From 2ceb544116b408a095af19723d13f3a553c146ff Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Fri, 12 Aug 2022 12:30:14 +0300 Subject: [PATCH 1/5] [gov]: Correcting the document title Based on the discussion in #3045 Signed-off-by: Gergely Csatari --- doc/gov/README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/gov/README.rst b/doc/gov/README.rst index 946fce9ed7..530f750b77 100644 --- a/doc/gov/README.rst +++ b/doc/gov/README.rst @@ -1,5 +1,6 @@ -Cloud iNfrastructure Telco Taskforce - Community Guidelines -=========================================================== +==================== +Community Guidelines +==================== Table of contents ----------------- From 21a72fecd7dd3cd18ee030aae58c8d56d8b4f957 Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Thu, 15 Sep 2022 15:06:30 +0100 Subject: [PATCH 2/5] [gov]: Update the title Signed-off-by: Gergely Csatari --- doc/gov/README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/gov/README.rst b/doc/gov/README.rst index 530f750b77..52c371c0f1 100644 --- a/doc/gov/README.rst +++ b/doc/gov/README.rst @@ -1,6 +1,6 @@ -==================== -Community Guidelines -==================== +========================================================== +Community Guidelines for Anuket Specifications Development +========================================================== Table of contents ----------------- From 3abb7e600f19404918605d6daec2c7d3d0963a50 Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Thu, 15 Dec 2022 15:04:03 +0200 Subject: [PATCH 3/5] [RA2 Ch3, Ch4 and Ch6]: Fixing trailing whitespaces Signed-off-by: Gergely Csatari --- doc/ref_arch/kubernetes/chapters/chapter03.rst | 4 ++-- doc/ref_arch/kubernetes/chapters/chapter04.rst | 6 +++--- doc/ref_arch/kubernetes/chapters/chapter06.rst | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) 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. From cd2637acae5459bc7f925f7a461ed8c55c922d9d Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Fri, 16 Dec 2022 10:36:06 +0200 Subject: [PATCH 4/5] [GOV]: Chaning index.rst to a link to README.rst Signed-off-by: Gergely Csatari --- doc/gov/index.rst | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) mode change 100644 => 120000 doc/gov/index.rst 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 From cd1e61238a5b1b4637f6f690c1afb1cbe5c8304f Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Wed, 18 Jan 2023 16:17:46 +0200 Subject: [PATCH 5/5] Update doc/common/chapter00.rst Co-authored-by: Pankaj Goyal <52107136+pgoyal01@users.noreply.github.com> --- doc/common/chapter00.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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