Skip to content

Commit 33a2bac

Browse files
authored
Merge pull request #1870 from cnti-testcatalog/github_runner_updates
Testsuite Repo URL Migration and Github Runner Updates
2 parents e54218b + 8ce3b4e commit 33a2bac

22 files changed

+154
-139
lines changed

CNF_TESTSUITE_YML_USAGE.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The cnf-testsuite.yml is used by `cnf_setup` in order to install the CNF to be tested onto an existing K8s cluster.
55

66

7-
The information in the cnf-testsuite.yml is also used for additional configuration of some tests e.g. `allowlist_helm_chart_container_names` is used for exculding containers from the [privileged](https://github.com/cncf/cnf-testsuite/blob/main/src/tasks/workload/security.cr#L196) container test.
7+
The information in the cnf-testsuite.yml is also used for additional configuration of some tests e.g. `allowlist_helm_chart_container_names` is used for exculding containers from the [privileged](https://github.com/cnti-testcatalog/testsuite/blob/main/src/tasks/workload/security.cr#L196) container test.
88

99

1010
### Table of Contents
@@ -16,7 +16,7 @@ The information in the cnf-testsuite.yml is also used for additional configurati
1616

1717
### Overview of all cnf-testsuite.yml
1818

19-
The following is a basic working example cnf-testsuite.yml file that can be found in the cnf-testsuite respository: [cnf-testsuite.example.yml](https://github.com/cncf/cnf-testsuite/blob/CNF_TESTSUITE_YML%231357/example-cnfs/coredns/cnf-testsuite.yml)
19+
The following is a basic working example cnf-testsuite.yml file that can be found in the cnf-testsuite respository: [cnf-testsuite.example.yml](https://github.com/cnti-testcatalog/testsuite/blob/CNF_TESTSUITE_YML%231357/example-cnfs/coredns/cnf-testsuite.yml)
2020

2121
```yaml=
2222
---
@@ -94,7 +94,7 @@ This is the path to the helm chart directory (relative to the location of the cn
9494

9595
An example of a helm directory can be found [here](https://github.com/helm/charts/tree/master/stable/coredns).
9696

97-
The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_coredns/cnf-testsuite.yml` and helm_directory is set to `helm_directory: chart` the test suite would expect to find the chart under [`sample-cnfs/sample_coredns/chart`](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample_coredns/chart)
97+
The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_coredns/cnf-testsuite.yml` and helm_directory is set to `helm_directory: chart` the test suite would expect to find the chart under [`sample-cnfs/sample_coredns/chart`](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample_coredns/chart)
9898

9999
Example Setting:
100100

@@ -117,9 +117,9 @@ Example Setting:
117117
This is the path to a directory of manifest files for installing the cnf (relative to the location of the cnf-testsuite.yml). This, or [helm_chart](#helm_chart), or [helm_directory](#helm_directory) must be set, but only one **(mutually exclusive)**. This argument is used by cnf_setup in order to deploy the CNF being tested onto an existing K8s cluster.
118118

119119

120-
An example of a manifest directory can be found [here](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample_nonroot/manifests).
120+
An example of a manifest directory can be found [here](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample_nonroot/manifests).
121121

122-
The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_nonroot/cnf-testsuite.yml` and manifest_directory is set to `manifest_directory: manifests` the test suite would expect to find the manifest files under [`sample-cnfs/sample_nonroot/manifests`](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample_nonroot/manifests)
122+
The PATH is also relative to the location of the cnf-testsuite.yml. So if the cnf-testsuite.yml is in the directory `sample-cnfs/sample_nonroot/cnf-testsuite.yml` and manifest_directory is set to `manifest_directory: manifests` the test suite would expect to find the manifest files under [`sample-cnfs/sample_nonroot/manifests`](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample_nonroot/manifests)
123123

124124
Example Setting:
125125

CONTRIBUTING.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Issues are used as the primary method for tracking items in the CNF Test Suite i
2727
### Issue Templates
2828

2929
**1. New Features:**
30-
To request an enhancement, please create a new issue using the [**Feature Request**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) Template
30+
To request an enhancement, please create a new issue using the [**Feature Request**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) Template
3131

3232
**2. Report Bugs:**
33-
To report a bug, please create a new issue using the [**Bug Report**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) Template. Check out [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html.).
33+
To report a bug, please create a new issue using the [**Bug Report**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) Template. Check out [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html.).
3434

3535
NOTE: To help with debugging, you can enable higher logging level output via the command line or env var
3636

@@ -55,11 +55,11 @@ Check [usage documentation](USAGE.md) for more info about invoking commands and
5555

5656
**3. New CNF Test Suite Tests:**
5757

58-
- To request a new workload test, please create a new issue using the [**New Workload Test**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) Template
59-
- To request a new platform test, please create a new issue using the [**New Platform Test**](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) Template
58+
- To request a new workload test, please create a new issue using the [**New Workload Test**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) Template
59+
- To request a new platform test, please create a new issue using the [**New Platform Test**](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) Template
6060

6161
**4. New CNF Example:**
62-
To suggest a new CNF, please create a GitHub issue using the [New Example CNF template](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=example+CNF&template=new-example-cnf.md&title=%5BCNF%5D).
62+
To suggest a new CNF, please create a GitHub issue using the [New Example CNF template](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=example+CNF&template=new-example-cnf.md&title=%5BCNF%5D).
6363

6464
To install the CNF Test Suite and run a CNF, follow instructions at:
6565

@@ -75,7 +75,7 @@ The test framework and tests (using upstream tools) are written in the human rea
7575

7676
Outline of what a contributor's workflow looks like:
7777

78-
1. Fork it (https://github.com/cncf/cnf-testsuite/fork)
78+
1. Fork it (https://github.com/cnti-testcatalog/testsuite/fork)
7979
1. Create a branch from where you want to base your work (usually main). Example `git checkout -b my-new-feature)`
8080
1. Read the [INSTALL.md](install for build and test instructions)
8181
1. Make your changes and arrange them in readable commits.
@@ -109,7 +109,7 @@ For general advice on how to submit a pull request, please see [Creating a pull
109109
`git clone git@github.com:<contributor-username>/cnf-testsuite.git`
110110
`cd cnf-testsuite`
111111
3. Add the original cnf-testsuite repo.
112-
`git remote add cncf git@github.com:cncf/cnf-testsuite.git`
112+
`git remote add cncf git@github.com:cnti-testcatalog/testsuite.git`
113113
4. Checkout the pull request's branch.
114114
`git checkout <pull-request's-branch-name>`
115115
5. Push the branch to the original cnf-testsuite repo.

CONTRIBUTION_LADDER.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ How you can learn more?
2525

2626
* Read the [install guide](INSTALL.md), [usage guide](USAGE.md), [FAQ](FAQ.md), and other documentation
2727
* Request a live demonstration and introduction of the test suite ([book a time on Calendly](https://calendly.com/cnftestsuite))
28-
* Come chat with us in [Slack](https://cloud-native.slack.com/archives/C014TNCEX8R) or start a [discussion](https://github.com/cncf/cnf-testsuite/discussions)
28+
* Come chat with us in [Slack](https://cloud-native.slack.com/archives/C014TNCEX8R) or start a [discussion](https://github.com/cnti-testcataglog/testsuite/discussions)
2929

3030
## Community Participant
3131

@@ -40,7 +40,7 @@ How you can be more involved and participate in the community:
4040
* Helping other users
4141
* Commenting on issues
4242
* Trying out new releases
43-
* Attending [community meetings](https://github.com/cncf/cnf-testsuite#communication-and-community-meetings) and events
43+
* Attending [community meetings](https://github.com/cnti-testcatalog/testsuite#communication-and-community-meetings) and events
4444

4545
## Contributor
4646

EXAMPLE-CNFS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This is a preliminary list of CNF samples for each layer in the [OSI model](http
1313

1414
## [Layer 7 - Application](https://en.wikipedia.org/wiki/Application_layer)
1515

16-
- [CoreDNS Sample CNF](https://github.com/cncf/cnf-testsuite/tree/main/sample-cnfs/sample-coredns-cnf)
16+
- [CoreDNS Sample CNF](https://github.com/cnti-testcatalog/testsuite/tree/main/sample-cnfs/sample-coredns-cnf)
1717
- [NFF Go Deep Packet Inspection example](https://github.com/intel-go/nff-go/tree/master/examples/dpi) example
1818

1919
## [Layer 6 - Presentation](https://en.wikipedia.org/wiki/Presentation_layer)

FAQ.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,23 @@
3737
<details> <summary>If I found a bug or I think it's a bug, how do I report it?</summary>
3838
<p>
3939

40-
- If you would like to report a bug, please create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) (using the **Bug Report** Template).
40+
- If you would like to report a bug, please create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) (using the **Bug Report** Template).
4141

4242
</p>
4343
</details>
4444

4545
<details> <summary>How do I request a new feature?</summary>
4646
<p>
4747

48-
- If you would like to request an enhancement, please create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) (using the **Feature Request** Template).
48+
- If you would like to request an enhancement, please create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=%5BFeature%5D) (using the **Feature Request** Template).
4949

5050
</p>
5151
</details>
5252

5353
<details> <summary>Can I request a new workload or platform test for the CNF Test Suite?</summary>
5454
<p>
5555

56-
- Yes. If you would like to request a new workload test, please create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) (using the **New Workload Test** Template) or create a [new issue](https://github.com/cncf/cnf-testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) (using the **New Platform Test** Template).
56+
- Yes. If you would like to request a new workload test, please create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=workload&template=new-workload-test.md&title=%5BWorkload%5D) (using the **New Workload Test** Template) or create a [new issue](https://github.com/cnti-testcatalog/testsuite/issues/new?assignees=&labels=platform&template=new-platform-test.md&title=%5BPlatform%5D) (using the **New Platform Test** Template).
5757

5858
</p>
5959
</details>
@@ -79,7 +79,7 @@
7979
<details> <summary>How are points assigned for tests?</summary>
8080
<p>
8181

82-
- Points are different for each test and workload but in general terms, pass defaults to 5 and fail is a -1. See [points.yml](https://github.com/cncf/cnf-testsuite/blob/main/embedded_files/points.yml) for more details on the different points for default scoring.
82+
- Points are different for each test and workload but in general terms, pass defaults to 5 and fail is a -1. See [points.yml](https://github.com/cnti-testcatalog/testsuite/blob/main/embedded_files/points.yml) for more details on the different points for default scoring.
8383

8484
</p>
8585
</details>

INSTALL.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ cd tools/ && git clone https://github.com/crosscloudci/k8s-infra.git
7676
We support the following methods of installing the cnf-testsuite:
7777

7878
- [Curl installation](#Curl-Binary-Installation) (via latest binary release)
79-
- [Latest Binary](https://github.com/cncf/cnf-testsuite/releases/latest) (manual download)
79+
- [Latest Binary](https://github.com/cnti-testcatalog/testsuite/releases/latest) (manual download)
8080
- From [**Source**](#Source-Install) on github.
8181
- [Air Gapped](#Air-Gapped)
8282

@@ -88,20 +88,20 @@ There are two methods to install via curl, we prefer the first method (the other
8888
- This first command using curl will download, install, and export the path automatically (recommended method):
8989

9090
```
91-
source <(curl -s https://raw.githubusercontent.com/cncf/cnf-testsuite/main/curl_install.sh)
91+
source <(curl -s https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/curl_install.sh)
9292
```
9393

9494
<details><summary>Click here for the alternate curl and manual install method</summary>
9595
<p>
9696

9797
- The other curl method to download and install requires you to export the PATH to the location of the executable:
9898
```
99-
curl -s https://raw.githubusercontent.com/cncf/cnf-testsuite/main/curl_install.sh | bash
99+
curl -s https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/curl_install.sh | bash
100100
```
101101

102102
- The Latest Binary (or you can select a previous release if desired) can be pulled down with wget, curl or you're own preferred method. Once downloaded you'll need to make the binary executable and manually add to your path:
103103
```
104-
wget https://github.com/cncf/cnf-testsuite/releases/download/latest/latest.tar.gz
104+
wget https://github.com/cnti-testcatalog/testsuite/releases/download/latest/latest.tar.gz
105105
tar xzf latest.tar.gz
106106
cd cnf-testsuite
107107
chmod +x cnf-testsuite
@@ -120,7 +120,7 @@ This is a brief summary for source installations and [does have requirements](#R
120120
Follow these steps to checkout the source from github and compile a cnf-testsuite binary:
121121

122122
```
123-
git clone https://github.com/cncf/cnf-testsuite.git
123+
git clone https://github.com/cnti-testcatalog/testsuite.git
124124
cd cnf-testsuite/
125125
shards install
126126
crystal build src/cnf-testsuite.cr
@@ -209,14 +209,14 @@ Now cnf-testsuite is setup, we're ready to configure it to point at a CNF to tes
209209
- If you want to use an example CNF, you can download our CoreDNS example CNF by doing the following:
210210

211211
```
212-
wget -O cnf-testsuite.yml https://raw.githubusercontent.com/cncf/cnf-testsuite/main/example-cnfs/coredns/cnf-testsuite.yml
212+
wget -O cnf-testsuite.yml https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/example-cnfs/coredns/cnf-testsuite.yml
213213
```
214214
- The wget gets a working config file, now tell cnf-testsuite to use it by doing the following:
215215
```
216216
cnf-testsuite cnf_setup cnf-config=./cnf-testsuite.yml
217217
```
218218

219-
- There are other examples in the [examples-cnfs](https://github.com/cncf/cnf-testsuite/tree/master/example-cnfs) directory that can be used for testing as well.
219+
- There are other examples in the [examples-cnfs](https://github.com/cnti-testcatalog/testsuite/tree/master/example-cnfs) directory that can be used for testing as well.
220220

221221
#### Bring Your Own CNF
222222

KIND-INSTALL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ for node in $(kind get nodes); do
5656
done
5757
```
5858

59-
Now you can use CNFs that require Multus and CNIs, e.g. [examples/ip-forwarder](https://github.com/cncf/cnf-testsuite/tree/main/example-cnfs/ip-forwarder)
59+
Now you can use CNFs that require Multus and CNIs, e.g. [examples/ip-forwarder](https://github.com/cnti-testcatalog/testsuite/tree/main/example-cnfs/ip-forwarder)

0 commit comments

Comments
 (0)