Clear up deployment specifics in documentation
Clarified:
- which kunitconfig is used
- how to configure for GCS
- reporting
- resources for deployment configuration
Change-Id: I71c0d2524c4fd29b3f75b05fe10a7c262ff85f3b
Signed-off-by: Avi Kondareddy <avikr@google.com>
diff --git a/README.md b/README.md
index a8d3369..ac361c8 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,10 @@
This repository contains all the code and instructions needed for generating a
docker container for building and running KUnit tests on Prow, and then using
-that container with a Prow cluster.
+that presubmit job container with a Prow cluster. Note that as of now, Prow will
+require a Google Cloud Storage Bucket for storing job artifacts and
+[Gubernator](https://github.com/kubernetes/test-infra/tree/master/gubernator)
+for a frontend to viewing them.
The official repo for Prow is
[test-infra](https://github.com/kubernetes/test-infra), Kubernetes' test
@@ -16,7 +19,8 @@
[kunit source](https://kunit.googlesource.com/linux/kunit/alpha/master), and
entrypoint script (kunit.sh) is ran. The script copies kunitconfig to working
directory, runs kunit.py, and sends output to job artifacts that can be viewed
-later. Prow will comment on the Gerrit change with the status of the job
+later from the link specified in the report. Prow will comment on the Gerrit
+change with the status of the job
(successful, a test failed, a test crashed, etc) and link to Prow URL for more
details. The container is currently configured to require the inclusion of
kunitconfig in repo. A convenience of this model is that updating the job image
@@ -27,7 +31,12 @@
The docker image is configured in the
[Dockerfile](Dockerfile). It is
based off of Debian, with kernel build tools installed and the script ran by the
-prowjob included. A couple peculiarities of building/running UML in a docker
+prowjob included.
+
+Note : The script sets kunitconfig to the latest kunitconfig at
+https://kunit.googlesource.com/kunitconfig at branch kunit/alpha/master.
+
+A couple peculiarities of building/running UML in a docker
container are solved in the deployment configuration discussed below under "Prow
Job Specification".
@@ -159,9 +168,10 @@
recommended for all new prowjobs and detailed at
[test-infra/prow/pod-utilities.md](https://github.com/kubernetes/test-infra/blob/master/prow/pod-utilities.md).
These utilities perform setup and capture output from the job container.
-This requires specifying a GCS Cloud Bucket in the Plank configuration
-in order to upload logs / artifacts from job container. Fill in the TODO's in
-[config.yaml](config.yaml) with your bucket details. See Prow API documentation
+The sidecar utility runs alongside the job container and uploads the artifacts
+to a GCS Bucket. Therefore, you must specify a GCS Cloud Bucket in the Plank
+configuration in order to upload logs / artifacts from job container. Fill in
+the TODO's in [config.yaml](config.yaml) with your bucket details. See Prow API documentation
under [DecorationConfig](https://godoc.org/k8s.io/test-infra/prow/apis/prowjobs/v1#DecorationConfig)
and test-infra's [default config.yaml](https://github.com/kubernetes/test-infra/blob/master/prow/config.yaml)
for details.
@@ -173,9 +183,8 @@
[kunitconfig](kunitconfig).
Prow sets the environment variable ARTIFACTS to specify a directory that will be
-exported to gcloud on job completion. It additionally sends all data send to
-stdout/stderr to the reporting interface. Exit code of 0 signals success and 1
-signals failure akin to regular shell scripts.
+exported to gcloud on job completion. Exit code of 0 signals success and 1
+signals failure which will be used when reporting the Job's state to gerrit.
## Prow Cluster Deployment
@@ -194,7 +203,11 @@
Checkout [prow/cluster/starter.yaml](
https://github.com/kubernetes/test-infra/blob/master/prow/cluster/starter.yaml)
for github presubmit instructions which requires oauth token authentication.
-Job configuration in config.yaml does not need to change.
+Job configuration in config.yaml does not need to change. [Prow/cluster](
+https://github.com/kubernetes/test-infra/tree/master/prow/cluster) generally
+has default deployments for all prow components and the documentation under
+[prow/cmd/{component}](https://github.com/kubernetes/test-infra/tree/master/prow/cmd)
+will specify the arguments to configure it.
Succinctly, a Kubernetes deployment file specifies all the API objects needed
for deployment. Each prow component is a container pod that is described in
diff --git a/config.yaml b/config.yaml
index 67fbdfb..603d709 100644
--- a/config.yaml
+++ b/config.yaml
@@ -20,11 +20,9 @@
entrypoint: "gcr.io/k8s-prow/entrypoint:v20181203-6a1345b"
sidecar: "gcr.io/k8s-prow/sidecar:v20181203-6a1345b"
gcs_configuration:
- bucket: "TODO"
- path_strategy: "TODO"
- default_org: "TODO"
- default_repo: "TODO"
- gcs_credentials_secret: "TODO"
+ bucket: "{GCS FILL IN WITH BUCKET NAME}"
+ path_strategy: "explicit"
+ gcs_credentials_secret: "{FILL IN WITH SECRET HOLDING KEY OF CLOUD SERVICE ACCOUNT}"
presubmits:
https://kunit.googlesource.com/linux:
