Docs: Relocate alpha_k8s_apis to configuration sections across docs (#…

…2082) Refs: #2077 - Interestingly there were as of yet unimplemented TO DO'S in USAGE.md and TEST_CATEGORIES.md which were also moved for future coherence (these relate to the k8s APIs category). Signed-off-by: svteb <[email protected]>
cnti-testcatalog · Jul 9, 2024 · 53554ed · 53554ed
1 parent c4eb30f
commit 53554ed
Showing 1 changed file with 23 additions and 24 deletions.
diff --git a/docs/TEST_DOCUMENTATION.md b/docs/TEST_DOCUMENTATION.md
@@ -4,7 +4,7 @@
 
 * [**Category: Compatibility, Installability and Upgradability Tests**](#category-compatibility-installability-and-upgradability-tests)
 
-   [[Increase decrease capacity]](#increase-decrease-capacity) | [[Helm chart published]](#helm-chart-published) | [[Helm chart valid]](#helm-chart-valid) | [[Helm deploy]](#helm-deploy) | [[Rollback]](#rollback) | [[Rolling version change]](#rolling-version-change) | [[Rolling update]](#rolling-update) | [[Rolling downgrade]](#rolling-downgrade) | [[CNI compatible]](#cni-compatible) | [[Kubernetes Alpha APIs **PoC**]](#kubernetes-alpha-apis-poc)
+   [[Increase decrease capacity]](#increase-decrease-capacity) | [[Helm chart published]](#helm-chart-published) | [[Helm chart valid]](#helm-chart-valid) | [[Helm deploy]](#helm-deploy) | [[Rollback]](#rollback) | [[Rolling version change]](#rolling-version-change) | [[Rolling update]](#rolling-update) | [[Rolling downgrade]](#rolling-downgrade) | [[CNI compatible]](#cni-compatible)
 
 * [**Category: Microservice Tests**](#category-microservice-tests)
 
@@ -28,8 +28,7 @@
 
 * [**Category: Configuration Tests**](#category-configuration-tests)
 
-   [[Default namespaces]](#default-namespaces) | [[Latest tag]](#latest-tag) | [[Require labels]](#require-labels) | [[Versioned tag]](#versioned-tag) | [[NodePort not used]](#nodeport-not-used) | [[HostPort not used]](#hostport-not-used) | [[Hardcoded IP addresses in K8s runtime configuration]](#hardcoded-ip-addresses-in-k8s-runtime-configuration) | [[Secrets used]](#secrets-used) | [[Immutable configmap]](#immutable-configmap)
-
+   [[Default namespaces]](#default-namespaces) | [[Latest tag]](#latest-tag) | [[Require labels]](#require-labels) | [[Versioned tag]](#versioned-tag) | [[NodePort not used]](#nodeport-not-used) | [[HostPort not used]](#hostport-not-used) | [[Hardcoded IP addresses in K8s runtime configuration]](#hardcoded-ip-addresses-in-k8s-runtime-configuration) | [[Secrets used]](#secrets-used) | [[Immutable configmap]](#immutable-configmap) | [[Kubernetes Alpha APIs **PoC**]](#kubernetes-alpha-apis-poc)
 * [**Category: 5G Tests**](#category-5g-tests)
 
    [[SMF UPF core validator]](#smf-upf-core-validator) | [[SUCI enabled]](#suci-enabled)
@@ -253,27 +252,6 @@ Ensure that your CNF is compatible with Calico, Cilium and other available CNIs.
 
 ----------
 
-### Kubernetes Alpha APIs **PoC**
-
-#### Overview
-
-This checks if a CNF uses alpha or unstable versions of Kubernetes APIs
-Expectation: CNF should not use Kubernetes alpha APIs
-
-#### Rationale
-
-If a CNF uses alpha or undocumented APIs, the CNF is tightly coupled to an unstable platform
-
-#### Remediation
-
-Make sure your CNFs are not utilizing any Kubernetes alpha APIs. You can learn more about Kubernetes API versioning [here](https://bit.ly/k8s_api).
-
-#### Usage
-
-`./cnf-testsuite alpha_k8s_apis`
-
-----------
-
 ## Category: Microservice Tests
 
 The CNF should be developed and delivered as a microservice. The CNTI Test Catalog tests to determine the organizational structure and rate of change of the CNF being tested. Once these are known we can detemine whether or not the CNF is a microservice. See: [Microservice-Principles](https://networking.cloud-native-principles.org/cloud-native-microservice-principles)
@@ -1542,6 +1520,27 @@ Use immutable configmaps for any non-mutable configuration data.
 
 ----------
 
+### Kubernetes Alpha APIs **PoC**
+
+#### Overview
+
+This checks if a CNF uses alpha or unstable versions of Kubernetes APIs
+Expectation: CNF should not use Kubernetes alpha APIs
+
+#### Rationale
+
+If a CNF uses alpha or undocumented APIs, the CNF is tightly coupled to an unstable platform
+
+#### Remediation
+
+Make sure your CNFs are not utilizing any Kubernetes alpha APIs. You can learn more about Kubernetes API versioning [here](https://bit.ly/k8s_api).
+
+#### Usage
+
+`./cnf-testsuite alpha_k8s_apis`
+
+----------
+
 ## Category: 5G Tests
 
 A 5g core is an important part of the service provider's telecommuncations offering. A cloud native 5g architecture uses immutable infrastructure, declarative configuration, and microservices when creating and hosting 5g cloud native network functions.