README
¶
Red Hat Best Practices Test Suite for Kubernetes
Objective
To provide a set of test cases for the Containerized Network Functions/Cloud Native Functions (CNFs) to verify if best practices for deployment on Red Hat OpenShift clusters are followed.
-
The test suite can be run as a standalone (after compiling the Golang code) or as a container.
-
The full documentation is published here. Please contact us in case the documentation is broken.
-
The catalog of all the available test cases can be found here.
Demo
Target Audience
- Partner
- Developer
Pre-requisites for Running the Test Suite
- OCP or Kubernetes Cluster
- Docker or Podman (if running the container-based version)
Pre-requisites Knowledge
- Basics of Kubernetes
- OpenShift Container Platform (OCP)
- Kubernetes Operator
License
Red Hat Best Practices Test Suite for Kubernetes is copyright Red Hat, Inc. and available under an Apache 2 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
results
Package results contains a Codec to convert JUnit results to claim Results.
|
Package results contains a Codec to convert JUnit results to claim Results. |
|
pkg
|
|
|
configuration
package configuration includes the definition of test suite configuration and the functions necessary to process the configuration
|
package configuration includes the definition of test suite configuration and the functions necessary to process the configuration |
|
diagnostics
Package diagnostic provides a test suite which gathers OpenShift cluster information.
|
Package diagnostic provides a test suite which gathers OpenShift cluster information. |
|
junit
Package junit provides utility conversion methods for encoding JUnit XML results to generic JSON.
|
Package junit provides utility conversion methods for encoding JUnit XML results to generic JSON. |
|
provider
provider package is responsible for providing data needed by tests it's considered as a shim layer between tests and autodiscovery/configuration package test code is not supposed to import autodiscover/configuration packages
|
provider package is responsible for providing data needed by tests it's considered as a shim layer between tests and autodiscovery/configuration package test code is not supposed to import autodiscover/configuration packages |
|
Package suite provides the entrypoint for running CNFCERT tests and producing a claim file.
|
Package suite provides the entrypoint for running CNFCERT tests and producing a claim file. |
|
accesscontrol
Package accesscontrol contains tests related to pod privilege, role-binding, namespace, host resource etc.
|
Package accesscontrol contains tests related to pod privilege, role-binding, namespace, host resource etc. |
|
certification
Package certification contains tests that retrieve results from other affiliated certification project through an API query, e.g.
|
Package certification contains tests that retrieve results from other affiliated certification project through an API query, e.g. |
|
common
Package common contains constants, structures and utility function shared by multiple test suites.
|
Package common contains constants, structures and utility function shared by multiple test suites. |
|
identifiers
Package identifiers contains TNF test identifiers.
|
Package identifiers contains TNF test identifiers. |
|
lifecycle
Package lifecycle contains k8s resource lifecycle related tests, such as pod scheduling, scaling, termination etc.
|
Package lifecycle contains k8s resource lifecycle related tests, such as pod scheduling, scaling, termination etc. |
|
networking
Package networking contains tests that check connectivity and networking config related best practices.
|
Package networking contains tests that check connectivity and networking config related best practices. |
|
observability
Package observability contains tests related to the observability of the CNF workloads under test, such as logging, status reporting etc
|
Package observability contains tests related to the observability of the CNF workloads under test, such as logging, status reporting etc |
|
operator
Package operator provides CNFCERT tests used to validate operator CNF facets.
|
Package operator provides CNFCERT tests used to validate operator CNF facets. |
|
platform
Package platform contains tests related to platform alteration such as kernel taint, boot param, huge page config, base image etc
|
Package platform contains tests related to platform alteration such as kernel taint, boot param, huge page config, base image etc |
Click to show internal directories.
Click to hide internal directories.