Skip to content
This repository was archived by the owner on Aug 26, 2022. It is now read-only.

Commit a865029

Browse files
crwr45ryandgoulding
authored andcommitted
update docs with container instructions
Signed-off-by: Charlie Wheeler-Robinson <[email protected]>
1 parent f4be1b9 commit a865029

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ RUN make install-tools && \
4444
make update-deps && \
4545
make build-cnf-tests
4646

47-
# Extract what's needed to run to a seperate location
47+
# Extract what's needed to run at a seperate location
4848
RUN mkdir ${TNF_BIN_DIR} && \
4949
cp run-cnf-suites.sh ${TNF_DIR} && \
5050
cp version.json ${TNF_DIR} && \
@@ -75,4 +75,4 @@ FROM scratch
7575
COPY --from=build / /
7676
ENV KUBECONFIG=/usr/tnf/kubeconfig/config
7777
WORKDIR /usr/tnf
78-
CMD ["./run-cnf-suites.sh", "-o", "claim", "generic"]
78+
CMD ["./run-cnf-suites.sh", "-o", "claim", "diagnostic", "generic"]

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,30 @@ Container Platform.
88
The suite is provided here in part so that CNF Developers can use the suite to test their CNFs readiness for
99
certification. Please see "CNF Developers" below for more information.
1010

11+
## Container
12+
13+
### Running
14+
15+
To run the tests in the container, use the following command. There are several required arguments:
16+
17+
* `-k` gives a path to the kube config file to be used by the container to authenticate with the cluster.
18+
* `-t` gives the local directory that contains tnf config files set up for the test.
19+
* `-o` gives the local directory that the test results will be available in once the container exits.
20+
* Finally, the specs to be run must be specified.
21+
22+
```shell-script
23+
./run-container.sh -k ~/.kube/config -t ~/tnf/config -o ~/tnf/output diagnostic generic
24+
```
25+
26+
### Building
27+
28+
The container can be built using the command below. Use the value of `TNF_VERSION` to set a branch or tag that will be
29+
installed into the container.
30+
31+
```shell-script
32+
docker build -t tnf --build-arg TNF_VERSION=1.0.3 .
33+
```
34+
1135
## Dependencies
1236

1337
At a minimum, the following dependencies must be installed *prior* to running `make install-tools`.

0 commit comments

Comments
 (0)