Skip to content

Commit

Permalink
Update README to prepare for public release
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewmcnew committed Aug 21, 2019
1 parent 8065116 commit b2f3731
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <IMAGE/NAME> # <IMAGE/NAME> is a writable and publicly accessible location
```
- Use the most recent [github release](https://github.com/pivotal/kpack/releases).

### Creating an Image Resource

Expand All @@ -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.
Expand Down Expand Up @@ -165,6 +160,15 @@ To view logs from a specific build use the build flag:
logs -kubeconfig <PATH-TO-KUBECONFIG> -image <IMAGE-NAME> -build <BUILD-NUMBER>
```

## 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 <IMAGE/NAME> # <IMAGE/NAME> is a writable and publicly accessible location
```

### Running Tests

* To run the e2e tests, kpack must be installed and running on a cluster
Expand Down

0 comments on commit b2f3731

Please sign in to comment.