Merge pull request #205 from cncf/develop

Microservice Documentation/Helm Deploy/NodePort
cnti-testcatalog · May 12, 2020 · 10683c6 · 10683c6
2 parents b557afd + 96e8479
commit 10683c6
Show file tree

Hide file tree

Showing 81 changed files with 2,895 additions and 210 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ The CNF Conformance Test Suite will inspect CNFs for the following characteristi
 - **Compatibility** - CNFs should work with any Certified Kubernetes product and any CNI-compatible network that meet their functionality requirements.
 - **Statelessness** - The CNF's state should be stored in a custom resource definition or a separate database (e.g. etcd) rather than requiring local storage. The CNF should also be resilient to node failure.
 - **Security** - CNF containers should be isolated from one another and the host.
+- **Microservice** - The CNF should be developed and delivered as a microservice.
 - **Scalability** - CNFs should support horizontal scaling (across multiple machines) and vertical scaling (between sizes of machines).
 - **Configuration and Lifecycle** - The CNF's configuration and lifecycle should be managed in a declarative manner, using ConfigMaps, Operators, or other declarative interfaces.  
 - **Observability** - CNFs should externalize their internal states in a way that supports metrics, tracing, and logging.

diff --git a/TEST-CATEGORIES.md b/TEST-CATEGORIES.md
@@ -21,6 +21,11 @@ The CNF Conformance program enables interoperability of CNFs from multiple vendo
 *  Check if there are any shells
 *  Check if any protected directories or files are accessed
 
+## Microservice Tests 
+#### The CNF should be developed and delivered as a microservice. The CNF Conformance suite 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):
+*  Check if the CNF have a reasonable startup time.
+*  Check the image size of the CNF.
+
 ## Scalability Tests  
 #### The CNF conformance suite checks to see if CNFs support horizontal scaling (across multiple machines) and vertical scaling (between sizes of machines) by using the native K8s [kubectl](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#scaling-resources) command to:
 *  Test increasing/decreasing capacity

diff --git a/USAGE.md b/USAGE.md
@@ -80,6 +80,22 @@ crystal src/cnf-conformance.cr shells
 crystal src/cnf-conformance.cr protected_access
 ```
 
+## Microservice Tests
+#### :heavy_check_mark: To run all of the microservice tests
+```
+crystal src/cnf-conformance.cr microservice
+```
+
+#### :heavy_check_mark: To check if the CNF has a reasonable image size
+```
+crystal src/cnf-conformance.cr reasonable_image_size
+```
+#### :heavy_check_mark: To check if the CNF have a reasonable startup time
+```
+crystal src/cnf-conformance.cr reasonable_startup_time
+```
+
+
 ## Scalability Tests
 
 #### :heavy_check_mark: To run all of the scalability tests

diff --git a/points.yml b/points.yml
@@ -59,7 +59,9 @@
 - name: no_volume_with_configuration
   tags: configuration_lifecycle, dynamic
 - name: rolling_update
-  tags: configuration_lifecycle, dynamic, installability
+  tags: configuration_lifecycle, dynamic
+- name: nodeport_not_used
+  tags: configuration_lifecycle, dynamic
 
 - name: fluentd_traffic
   tags: observability, dynamic

diff --git a/sample-cnfs/sample-bad-helm-deploy-repo/README.md b/sample-cnfs/sample-bad-helm-deploy-repo/README.md
@@ -0,0 +1,39 @@
+# Set up Sample CoreDNS CNF
+./sample-cnfs/sample-coredns-cnf/readme.md
+# Prerequistes
+### Install helm
+```
+curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
+chmod 700 get_helm.sh
+./get_helm.sh
+```
+### Optional: Use a helm version manager
+https://github.com/yuya-takeyama/helmenv
+Check out helmenv into any path (here is ${HOME}/.helmenv)
+```
+${HOME}/.helmenv)
+$ git clone https://github.com/yuya-takeyama/helmenv.git ~/.helmenv
+```
+Add ~/.helmenv/bin to your $PATH any way you like
+```
+$ echo 'export PATH="$HOME/.helmenv/bin:$PATH"' >> ~/.bash_profile
+```
+```
+helmenv versions 
+helmenv install <version 3.1?>
+```
+
+### core-dns installation
+```
+helm install coredns stable/coredns
+```
+### Pull down the helm chart code, untar it, and put it in the cnfs/coredns directory
+```
+helm pull stable/coredns
+```
+### Example cnf-conformance config file for sample-core-dns-cnf
+In ./cnfs/sample-core-dns-cnf/cnf-conformance.yml
+```
+---
+container_names: [coredns-coredns] 
+```
diff --git a/sample-cnfs/sample-bad-helm-deploy-repo/cnf-conformance.yml b/sample-cnfs/sample-bad-helm-deploy-repo/cnf-conformance.yml
@@ -0,0 +1,16 @@
+---
+helm_directory: cnfs/coredns/helm_chart/coredns
+# helm_directory: helm_chart
+git_clone_url:
+install_script:
+release_name: coredns
+deployment_name: coredns-coredns
+service_name: coredns-coredns
+application_deployment_names: [coredns-coredns]
+helm_repository:
+  name: stable
+  repo_url: https://bad-helm-repo.googleapis.com
+helm_chart:
+helm_chart_container_name: coredns
+rolling_update_tag: 1.6.7
+white_list_helm_chart_container_names: [falco, node-cache, nginx, coredns, calico-node, kube-proxy, nginx-proxy]
diff --git a/sample-cnfs/sample-bad-helm-repo/cnf-conformance.yml b/sample-cnfs/sample-bad-helm-repo/cnf-conformance.yml
@@ -5,6 +5,7 @@ git_clone_url:
 install_script: 
 release_name: coredns
 deployment_name: coredns-coredns 
+service_name: coredns-coredns 
 application_deployment_names: [coredns-coredns]
 helm_repository:
   name: stable 

diff --git a/sample-cnfs/sample-bad_helm_coredns-cnf/cnf-conformance.yml b/sample-cnfs/sample-bad_helm_coredns-cnf/cnf-conformance.yml
@@ -4,6 +4,7 @@ git_clone_url:
 install_script: 
 release_name: bad-helm-coredns-coredns
 deployment_name: bad-helm-coredns-coredns
+service_name: bad-helm-coredns-coredns
 application_deployment_names: [bad-helm-coredns]
 helm_chart: stable/coredns
 helm_chart_container_name: coredns

diff --git a/sample-cnfs/sample-coredns-cnf-bad-chart/cnf-conformance.yml b/sample-cnfs/sample-coredns-cnf-bad-chart/cnf-conformance.yml
@@ -5,6 +5,7 @@ git_clone_url:
 install_script: 
 release_name: coredns
 deployment_name: coredns-coredns 
+service_name: coredns-coredns 
 application_deployment_names: [coredns-coredns]
 docker_repository: coredns/coredns
 helm_repository:

diff --git a/sample-cnfs/sample-coredns-cnf-source/cnf-conformance.yml b/sample-cnfs/sample-coredns-cnf-source/cnf-conformance.yml
@@ -5,6 +5,7 @@ git_clone_url: https://github.com/coredns/coredns.git
 install_script: coredns/Makefile
 release_name: coredns
 deployment_name: coredns-coredns 
+service_name: coredns-coredns 
 application_deployment_names: [coredns-coredns]
 helm_chart: stable/coredns
 helm_chart_container_name: coredns

diff --git a/sample-cnfs/sample-coredns-cnf/cnf-conformance.yml b/sample-cnfs/sample-coredns-cnf/cnf-conformance.yml
@@ -5,6 +5,7 @@ git_clone_url:
 install_script: 
 release_name: coredns
 deployment_name: coredns-coredns 
+service_name: coredns-coredns 
 application_deployment_names: [coredns-coredns]
 docker_repository: coredns/coredns
 helm_repository:

diff --git a/sample-cnfs/sample-generic-cnf/cnf-conformance.yml b/sample-cnfs/sample-generic-cnf/cnf-conformance.yml
@@ -4,6 +4,7 @@ git_clone_url: https://github.com/coredns/coredns.git
 install_script: cnfs/coredns/Makefile
 release_name: coredns
 deployment_name: coredns-coredns 
+service_name: coredns-coredns 
 application_deployment_names: [coredns-coredns]
 docker_repository: coredns/coredns
 helm_repository:

diff --git a/sample-cnfs/sample-large-cnf/cnf-conformance.yml b/sample-cnfs/sample-large-cnf/cnf-conformance.yml
@@ -4,7 +4,8 @@ helm_directory: chart
 git_clone_url: 
 install_script: 
 release_name: coredns
-deployment_name: coredns-coredns 
+deployment_name: coredns-coredns
+service_name: coredns-coredns 
 application_deployment_names: [coredns-coredns]
 docker_repository: coredns/coredns
 helm_repository:

diff --git a/sample-cnfs/sample_coredns/cnf-conformance.yml b/sample-cnfs/sample_coredns/cnf-conformance.yml
@@ -4,6 +4,7 @@ git_clone_url:
 install_script: chart
 release_name: coredns
 deployment_name: coredns-coredns 
+service_name: coredns-coredns
 application_deployment_names: [coredns-coredns]
 helm_chart: stable/coredns
 helm_chart_container_name: coredns-coredns

diff --git a/sample-cnfs/sample_coredns_bad_liveness/cnf-conformance.yml b/sample-cnfs/sample_coredns_bad_liveness/cnf-conformance.yml
@@ -4,6 +4,7 @@ git_clone_url:
 install_script: chart
 release_name: bad-liveness
 deployment_name: bad-liveness-coredns 
+service_name: bad-liveness-coredns 
 application_deployment_names: [bad-liveness-coredns]
 helm_chart: stable/coredns
 helm_chart_container_name: bad-liveness-coredns

diff --git a/sample-cnfs/sample_coredns_chart_directory/README.md b/sample-cnfs/sample_coredns_chart_directory/README.md
@@ -0,0 +1,39 @@
+# Set up Sample CoreDNS CNF
+./sample-cnfs/sample-coredns-cnf/readme.md
+# Prerequistes
+### Install helm
+```
+curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
+chmod 700 get_helm.sh
+./get_helm.sh
+```
+### Optional: Use a helm version manager
+https://github.com/yuya-takeyama/helmenv
+Check out helmenv into any path (here is ${HOME}/.helmenv)
+```
+${HOME}/.helmenv)
+$ git clone https://github.com/yuya-takeyama/helmenv.git ~/.helmenv
+```
+Add ~/.helmenv/bin to your $PATH any way you like
+```
+$ echo 'export PATH="$HOME/.helmenv/bin:$PATH"' >> ~/.bash_profile
+```
+```
+helmenv versions 
+helmenv install <version 3.1?>
+```
+
+### core-dns installation
+```
+helm install coredns stable/coredns
+```
+### Pull down the helm chart code, untar it, and put it in the cnfs/coredns directory
+```
+helm pull stable/coredns
+```
+### Example cnf-conformance config file for sample-core-dns-cnf
+In ./cnfs/sample-core-dns-cnf/cnf-conformance.yml
+```
+---
+container_names: [coredns-coredns] 
+```
diff --git a/sample-cnfs/sample_coredns_chart_directory/chart/.helmignore b/sample-cnfs/sample_coredns_chart_directory/chart/.helmignore
@@ -0,0 +1,22 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+OWNERS
diff --git a/sample-cnfs/sample_coredns_chart_directory/chart/Chart.yaml b/sample-cnfs/sample_coredns_chart_directory/chart/Chart.yaml
@@ -0,0 +1,23 @@
+apiVersion: v1
+appVersion: 1.6.7
+description: CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS
+  Services
+home: https://coredns.io
+icon: https://coredns.io/images/CoreDNS_Colour_Horizontal.png
+keywords:
+- coredns
+- dns
+- kubedns
+maintainers:
+- email: hello@acale.ph
+  name: Acaleph
+- email: shashidhara.huawei@gmail.com
+  name: shashidharatd
+- email: andor44@gmail.com
+  name: andor44
+- email: manuel@rueg.eu
+  name: mrueg
+name: coredns
+sources:
+- https://github.com/coredns/coredns
+version: 1.10.0