From 52881dce959433f6e896d796dcd8ae2b04b9f05d Mon Sep 17 00:00:00 2001 From: Olivier Smith <61708516+Smitholi67@users.noreply.github.com> Date: Fri, 6 Dec 2024 10:03:34 -0500 Subject: [PATCH] Update code-of-conduct.md (#2189) * Update README.md - Corrected capitalizations - Some minor wording improvements for readability - Replaced incorrect link to Code of Conduct - Removed outdated text regarding Equinix and CNF Testbed * Update code-of-conduct.md Corrected link from CNCF Code of Conduct to LF's Code of Conduct. * Update README.md Removed Past Presentations section Corrected another capitalization error --- README.md | 47 +++++++++++++++++----------------------------- code-of-conduct.md | 4 ++-- 2 files changed, 19 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index fb53c90f3..914583174 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -# CNTI Test Catalog +# CNTi Test Catalog | Main | | ------------------------------------------------------------------------------------------------------------------------------------------- | | [![Build Status](https://github.com/cnti-testcatalog/testsuite/workflows/Crystal%20Specs/badge.svg)](https://github.com/cnti-testcatalog/testsuite/actions) | -The CNTI Test Catalog is a tool that validates telco application's adherence to [cloud native principles](https://networking.cloud-native-principles.org/) and best practices. +The CNTi Test Catalog is an open source and vendor neutral tool that can be used to validate a telco application's adherence to [cloud native principles](https://networking.cloud-native-principles.org/) and best practices. -This Test Catalog focus area is one part of LF Networking's [Cloud Native Telecom Initiative (CNTI)](https://wiki.lfnetworking.org/pages/viewpage.action?pageId=113213592) and works closely with the [CNTI Best Practices](https://wiki.lfnetworking.org/display/LN/Best+Practices) and [CNTI Certification](https://wiki.lfnetworking.org/display/LN/Certification) focus areas. +This Test Catalog focus area is one part of LF Networking's [Cloud Native Telecom Initiative (CNTi)](https://wiki.lfnetworking.org/pages/viewpage.action?pageId=113213592) and works closely with the [CNTi Best Practices](https://wiki.lfnetworking.org/display/LN/Best+Practices) and [CNTi Certification](https://wiki.lfnetworking.org/display/LN/Certification) focus areas. ## Installation and Usage -To get the CNTI Test Catalog up and running, see the [Installation Guide](INSTALL.md). +To get the CNTi Test Catalog up and running, see the [Installation Guide](INSTALL.md). #### To give it a try immediately you can use these quick install steps -Prereqs: kubernetes cluster, wget, curl, helm 3.1.1 or greater on your system already. +Prereqs: Kubernetes cluster, wget, curl, helm 3.1.1 or greater on your system already. 1. Install the latest test suite binary: `source <(curl -s https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/curl_install.sh)` 2. Run `setup` to prepare the cnf-testsuite: `cnf-testsuite setup` @@ -26,9 +26,9 @@ Prereqs: kubernetes cluster, wget, curl, helm 3.1.1 or greater on your system al Check out the [usage documentation](USAGE.md) for more info about invoking commands and logging. -## Cloud Native Categories +## Cloud Native Test Categories -The CNTI Test Catalog will inspect CNFs for the following characteristics: +The CNTi Test Catalog will inspect CNFs for the following characteristics: - **Configuration** - The CNF's configuration should be managed in a declarative manner, using ConfigMaps, Operators, or other declarative interfaces. - **Compatibility, Installability & Upgradability** - CNFs should work with any Certified Kubernetes product and any CNI-compatible network that meet their functionality requirements while using standard, in-band deployment tools such as Helm (version 3) charts. @@ -38,7 +38,7 @@ The CNTI Test Catalog will inspect CNFs for the following characteristics: - **Observability & Diagnostics** - CNFs should externalize their internal states in a way that supports metrics, tracing, and logging. - **Security** - CNF containers should be isolated from one another and the host. CNFs are to be verified against any common CVE or other vulnerabilities. -See the [Complete Test Documentation](docs/TEST_DOCUMENTATION.md) for a complete overview of the tests. +See the [Test Documentation](docs/TEST_DOCUMENTATION.md) for a complete overview of the tests. ## Contributing @@ -48,36 +48,23 @@ Welcome! We gladly accept contributions on new tests, example CNFs, updates to d - [Good first issues](https://github.com/cnti-testcatalog/testsuite/labels/good%20first%20issue) - [Contributions welcome](https://github.com/cnti-testcatalog/testsuite/labels/contributions-welcome) -## Communication and community meetings +## Communication and Community Meetings - Join the conversation on [LFN Tech's Slack](https://lfntech.slack.com/) channel [#cnti](https://lfntech.slack.com/archives/C06HQGWK4NL) -- Join the weekly CNTI Test Catalog meeting - - Meetings every Tuesday at 8:00am - 9:00am Pacific Time - - Meeting minutes are [here](https://docs.google.com/document/d/1yjL079TR0L1q__BRuhREeXfx5MtAmjPzbFZlZUeBsK4/edit) +- Join the weekly CNTi Test Catalog meeting + - [Meeting details](https://lf-networking.atlassian.net/wiki/spaces/CNTi/pages/130416641/Cloud+Native+Telecom+Initiative+CNTi#Test-Catalog) + - [Meeting minutes](https://docs.google.com/document/d/1yjL079TR0L1q__BRuhREeXfx5MtAmjPzbFZlZUeBsK4/edit) -## Past Presentations +## Implementation Overview -**CNTI Test Catalog Demo 2021** -- [Recording](https://drive.google.com/file/d/1SBHE5Dqx6Sa-m83WODbCEbbdiB2_l_U2/view?usp=sharing) -- [Slides](https://github.com/cnti-testcatalog/testsuite/files/6857515/SHARED-COMMON.CNF.Test.Suite.Demo.and.CNF.initiatives.overview.2021-06-29.pdf) (PDF) - -**Crystal in the Cloud: A cloud native journey at Crystal 1.0 Conference 2021** -- [Recording](https://youtu.be/n8g60VglyUw) -- [Slides](https://github.com/cnti-testcatalog/testsuite/files/6785788/Crystal.1.0.Crystal.in.the.Cloud_.CNF.Test.Suite.pdf) (PDF) - - -## Implementation overview - -The CNTI Test Catalog leverages upstream tools such as [OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper), [Helm linter](https://github.com/helm/chart-testing), and [Promtool](https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/) for testing CNFs. The upstream tool installation, configuration, and versioning has been made repeatable. +The CNTi Test Catalog leverages upstream tools such as [OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper), [Helm linter](https://github.com/helm/chart-testing), and [Promtool](https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/) for testing CNFs. The upstream tool installation, configuration, and versioning has been made repeatable. The test framework and tests (using the upstream tools) are written in the human-readable, compiled language, [Crystal](https://crystal-lang.org/). Common capabilities like dependencies between tests and categories are supported. -Setup of vanilla upstream K8s on [Equinix Metal](https://metal.equinix.com/) is done with the [CNF Testbed](https://github.com/cncf/cnf-testbed/) platform tool chain, which includes [k8s-infra](https://github.com/crosscloudci/k8s-infra), [Kubespray](https://kubespray.io/). To add support for other providers, please submit a [Pull Request](https://github.com/cncf/cnf-testbed/pulls) to the [CNF Testbed](https://github.com/cncf/cnf-testbed/) repo. - ## Code of Conduct -The CNTI Test Catalog community follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). +The CNTi community follows the [LF's Code of Conduct](https://lfprojects.org/policies/code-of-conduct/). -## License terms +## License Terms -The CNTI Test Catalog is available under the [Apache 2 license](LICENSE.md). +The CNTi Test Catalog is available under the [Apache 2 license](LICENSE.md). diff --git a/code-of-conduct.md b/code-of-conduct.md index 163c0c071..ea093cb14 100644 --- a/code-of-conduct.md +++ b/code-of-conduct.md @@ -1,4 +1,4 @@ # Code of Conduct -The CNF Test Suite community follows the -[CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). +The CNTi community follows the +[LF's Code of Conduct](https://lfprojects.org/policies/code-of-conduct/).