From b2f3731dc42e17023952efa5a65c9bb030a3d809 Mon Sep 17 00:00:00 2001 From: Matthew McNew Date: Wed, 21 Aug 2019 13:00:54 -0600 Subject: [PATCH] Update README to prepare for public release --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3807bb994..2333678fe 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,16 @@ # kpack -Experimental declarative Build Service Kubernetes CRDs. +Experimental Build Service Kubernetes Resource Controllers. ## Pre requirements - Kubernetes cluster +- `kubectl` cli +- Docker V2 Registry ## Install -- Use the most recent github release. - -## Local Development Install - -Access to a Kubernetes cluster is needed in order to install the kpack controllers. - -```bash -kubectl cluster-info # ensure you have access to a cluster -./hack/apply.sh # is a writable and publicly accessible location -``` +- Use the most recent [github release](https://github.com/pivotal/kpack/releases). ### Creating an Image Resource @@ -29,6 +22,8 @@ kubectl cluster-info # ensure you have access to a cluster name: sample-builder spec: image: cloudfoundry/cnb:bionic + imagePullSecrets: # optional, if not set builder must be public + - name: builder-secret ``` 2. Create a secret for push access to the desired docker registry. The example below is for a registry on gcr. @@ -165,6 +160,15 @@ To view logs from a specific build use the build flag: logs -kubeconfig -image -build ``` +## Local Development Install + +Access to a Kubernetes cluster is needed in order to install the kpack controllers. + +```bash +kubectl cluster-info # ensure you have access to a cluster +./hack/apply.sh # is a writable and publicly accessible location +``` + ### Running Tests * To run the e2e tests, kpack must be installed and running on a cluster