Skip to content

Commit

Permalink
Replace tnf
Browse files Browse the repository at this point in the history
  • Loading branch information
bnshr committed Nov 15, 2024
1 parent 884a656 commit a6a5b5b
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/assets/images/claim-compare-cni.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/claim-compare-nodes.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/claim-compare-results.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/claim-compare-self.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/claim-compare-versions.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/demo-certsuite.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/demo-config.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/images/overview-new.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/cluster-deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ patches:
- op: replace
path: /spec/containers/0/args/1
value: |
./run-cnf-suites.sh -l 'preflight' ; sleep inf
./certsuite.sh -l 'preflight' ; sleep inf
- target:
version: v1
kind: Pod
Expand Down
16 changes: 8 additions & 8 deletions docs/cluster-deploy/certsuite.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ metadata:
data:
certsuite_config.yaml: |
targetNameSpaces:
- name: tnf
- name: certsuite
podsUnderTestLabels:
- "redhat-best-practices-for-k8s.com/generic: target"
# deprecated operator label ("redhat-best-practices-for-k8s.com/operator:"") still configured by default, no need to add it here
Expand Down Expand Up @@ -71,10 +71,10 @@ data:
- module: vboxguest
skipScalingTestDeployments:
- name: deployment1
namespace: tnf
namespace: certsuite
skipScalingTestStatefulsets:
- name: statefulset1
namespace: tnf
namespace: certsuite
skipHelmChartList:
- name: coredns
validProtocolNames:
Expand Down Expand Up @@ -127,12 +127,12 @@ spec:
args:
- "-c"
- |
./run-cnf-suites.sh -l '!affiliated-certification-container-is-certified-digest && !access-control-security-context' ; sleep inf
./certsuite.sh -l '!affiliated-certification-container-is-certified-digest && !access-control-security-context' ; sleep inf
volumeMounts:
- name: config-volume
mountPath: /usr/tnf/config
mountPath: /usr/certsuite/config
- name: preflight-dockerconfig
mountPath: /usr/tnf/config/preflight
mountPath: /usr/certsuite/config/preflight
env:
- name: CERTSUITE_NON_INTRUSIVE_ONLY
value: "true"
Expand All @@ -141,6 +141,6 @@ spec:
- name: CERTSUITE_LOG_LEVEL
value: trace
- name: PFLT_DOCKERCONFIG
value: /usr/tnf/config/preflight/preflight_dockerconfig.json
value: /usr/certsuite/config/preflight/preflight_dockerconfig.json
- name: CERTSUITE_CONFIGURATION_PATH
value: /usr/tnf/config/certsuite_config.yaml
value: /usr/certsuite/config/certsuite_config.yaml
2 changes: 1 addition & 1 deletion docs/cluster-deploy/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ resources:
# - op: replace
# path: /spec/containers/0/args/1
# value: |
# ./run-cnf-suites.sh -l 'preflight' ; sleep inf
# ./certsuite.sh -l 'preflight' ; sleep inf

# Uncomment the next lines (patches) in order to allow intrusive TCs to run.
# patches:
Expand Down
12 changes: 6 additions & 6 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The namespaces in which the workload under test will be deployed.

``` { .yaml .annotate }
targetNameSpaces:
- name: tnf
- name: certsuite
```

#### podsUnderTestLabels
Expand Down Expand Up @@ -79,13 +79,13 @@ The CRD name suffix used to filter the workload's CRDs among all the CRDs presen

``` { .yaml .annotate }
targetCrdFilters:
- nameSuffix: "group1.tnf.com"
- nameSuffix: "group1.certsuite.com"
scalable: false
- nameSuffix: "anydomain.com"
scalable: true
```

With the config show above, all CRD names in the cluster whose names have the suffix _group1.tnf.com_ or _anydomain.com_ ( e.g. _crd1.group1.tnf.com_ or _mycrd.mygroup.anydomain.com_) will be tested.
With the config show above, all CRD names in the cluster whose names have the suffix _group1.certsuite.com_ or _anydomain.com_ ( e.g. _crd1.group1.certsuite.com_ or _mycrd.mygroup.anydomain.com_) will be tested.

#### managedDeployments / managedStatefulSets

Expand Down Expand Up @@ -191,17 +191,17 @@ Test cases affected: _lifecycle-deployment-scaling_, _lifecycle-statefulset-scal
``` { .yaml .annotate }
skipScalingTestDeployments:
- name: deployment1
namespace: tnf
namespace: certsuite
skipScalingTestStatefulSetNames:
- name: statefulset1
namespace: tnf
namespace: certsuite
```

### Red Hat Best Practices Test Suite settings

#### probeDaemonSetNamespace

This is an optional field with the name of the namespace where a privileged DaemonSet will be deployed. The namespace will be created in case it does not exist. In case this field is not set, the default namespace for this DaemonSet is _cnf-suite_.
This is an optional field with the name of the namespace where a privileged DaemonSet will be deployed. The namespace will be created in case it does not exist. In case this field is not set, the default namespace for this DaemonSet is _certsuite_.

``` { .yaml .annotate }
probeDaemonSetNamespace: cnf-cert
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The purpose of the tests and the framework is to test the interaction of the wor

There are 3 building blocks in the above framework.

* the `CNF` represents the workload to be certified. The Test Suite identifies the resources (containers/pods/operators etc) belonging to the workload via labels or static data entries in the Config File
* the `CertSuite` represents the workload to be certified. The Test Suite identifies the resources (containers/pods/operators etc) belonging to the workload via labels or static data entries in the Config File

* the `Certification container/exec` is the Test Suite running on the platform or in a container. The executable verifies the workload under test configuration and its interactions with OpenShift

Expand Down
8 changes: 4 additions & 4 deletions docs/test-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The test suite also saves a copy of the execution logs at [test output directory

After running all the test cases, a compressed file will be created with all the results files and web artifacts to review them. The file has a UTC date-time prefix and looks like this:

20230620-110654-cnf-test-results.tar.gz
20230620-110654-certsuite-test-results.tar.gz

The "20230620-110654" sample prefix means "June-20th 2023, 11:06:54"

Expand All @@ -79,7 +79,7 @@ https://github.com/redhat-best-practices-for-k8s/parser

## Compare claim files from two different Test Suite runs

Partners can use the `tnf claim compare` tool in order to compare two claim files. The differences are shown in a table per section.
Partners can use the `certsuite claim compare` tool in order to compare two claim files. The differences are shown in a table per section.
This tool can be helpful when the result of some test cases is different between two (consecutive) runs, as it shows
configuration differences in both the Test Suite config and the cluster nodes that could be the root cause for
some of the test cases results discrepancy.
Expand Down Expand Up @@ -149,7 +149,7 @@ CNIs: Only in CLAIM 2

### How to build the certsuite tool

The _certsuite_ tool is located in the repo's `cmd/tnf` folder. In order to compile it, just run:
The _certsuite_ tool is located in the repo's `cmd/certsuite` folder. In order to compile it, just run:

```console
make build-certsuite-tool
Expand All @@ -176,7 +176,7 @@ During the second run, there was a test case that failed. Let's simulate it modi
#### Different cluster configurations

First, let's simulate that the second run took place in a cluster with a different OCP version. As we store the OCP version in the claim file (section claim.versions), we can also modify it manually.
The versions section comparison appears at the very beginning of the `tnf claim compare` output:
The versions section comparison appears at the very beginning of the `certsuite claim compare` output:

<!-- markdownlint-disable MD033 -->
<object type="image/svg+xml" data="../assets/images/claim-compare-versions.svg" width="100%" height=auto></object>
Expand Down

0 comments on commit a6a5b5b

Please sign in to comment.