Skip to content

Commit

Permalink
Add supported versions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
SaschaSchwarze0 committed May 12, 2020
1 parent c65d867 commit 8167116
Showing 1 changed file with 22 additions and 19 deletions.
41 changes: 22 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,39 @@
</a>
</p>

## The `build` Kubernetes API
# The `build` Kubernetes API

Codenamed build-v2

An API to build container-images on Kubernetes using popular strategies and tools like `source-to-image`, `buildpack-v3`, `kaniko`, `jib` and `buildah`, in an extensible way.

## Dependencies

| Dependency | Supported versions |
| ----------------------------------------- | ---------------------------- |
| [Kubernetes](https://kubernetes.io/) | v1.15.\*, v1.16.\*, v1.17.\* |
| [Tekton](https://cloud.google.com/tekton) | v0.11.\* |

## How

The following are the `BuildStrategies` supported by this operator, out-of-the-box:
The following are the build strategies supported by this operator, out-of-the-box:

* [Source-to-Image](samples/buildstrategy/source-to-image/README.md)
* [Buildpacks-v3](samples/buildstrategy/buildpacks-v3/README.md)
* [Buildah](samples/buildstrategy/buildah/README.md)
* [Kaniko](samples/buildstrategy/kaniko/README.md)

Users have the option to define their own `BuildStrategies` resources and make them available for consumption
via the `Build` resource.
Users have the option to define their own `BuildStrategy` or `ClusterBuildStrategy` resources and make them available for consumption via the `Build` resource.

## Operator Resources

This operator ships two CRDs(the `Build` and `BuildRun`) in order to register a strategy and then start the actual application builds using a registered strategy.

## Read the Docs

| Version | Docs | Examples |
| ------- | ---- | -------- |
| HEAD | [Docs @ HEAD](/docs/README.md) | [Examples @ HEAD](/samples) |
| Version | Docs | Examples |
| ------- | ------------------------------ | --------------------------- |
| HEAD | [Docs @ HEAD](/docs/README.md) | [Examples @ HEAD](/samples) |

## Examples

Expand All @@ -47,17 +53,12 @@ Examples of `Build` resource using the example strategies shipped with this oper

## Try it!

- Install Tekton, optionally you could use
[OpenShift Pipelines Community Operator][pipelinesoperator]

- Install [operator-sdk][operatorsdk]

- Create a project or namespace called **build-examples** by using `kubectl create namespace build-examples`

- Execute `make local` to register [well-known build strategies](samples/buildstrategies) including **Kaniko**
and start the operator.

- Create a [Kaniko](samples/build/build_kaniko_cr.yaml) build
* Get a [Kubernetes](https://kubernetes.io/) cluster and [`kubectl`](https://kubernetes.io/docs/reference/kubectl/overview/) set up to connect to your cluster.
* Install [Tekton](https://cloud.google.com/tekton) by running [install-tekton.sh](hack/install-tekton.sh), it installs v0.11.3.
* Install [operator-sdk][operatorsdk] by running [install-operator-sdk.sh](hack/install-operator-sdk.sh), it installs v0.17.0.
* Create a namespace called **build-examples** by running `kubectl create namespace build-examples`.
* Execute `make local` to register [well-known build strategies](samples/buildstrategy) including **Kaniko** and start the operator locally.
* Create a [Kaniko](samples/build/build_kaniko_cr.yaml) build.

```yaml
apiVersion: build.dev/v1alpha1
Expand All @@ -77,7 +78,7 @@ spec:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
```
- Start a [Kaniko](samples/buildrun/buildrun_kaniko_cr.yaml) buildrun
* Start a [Kaniko](samples/buildrun/buildrun_kaniko_cr.yaml) buildrun
```yaml
apiVersion: build.dev/v1alpha1
Expand All @@ -88,6 +89,8 @@ metadata:
spec:
buildRef:
name: kaniko-golang-build
serviceAccount:
generate: true
```
## Development
Expand Down

0 comments on commit 8167116

Please sign in to comment.