diff --git a/.docs/shipwright-logo-stacked-lightbg.svg b/.docs/shipwright-logo-stacked-lightbg.svg new file mode 100644 index 0000000000..3f9b279dfb --- /dev/null +++ b/.docs/shipwright-logo-stacked-lightbg.svg @@ -0,0 +1,141 @@ + + diff --git a/README.md b/README.md index e3afe14f65..c63d4bc8c6 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,26 @@ SPDX-License-Identifier: Apache-2.0 # Shipwright +
+ +
+ Shipwright is an extensible framework for building container images on Kubernetes. ## Why? With Shipwright developers get a simplified approach for building container images, by defining a minimal YAML that does not require -any previous knowledge of containers or containers tooling. All you need is your source code in git and access to a container registry. +any previous knowledge of containers or container tooling. All you need is your source code in git and access to a container registry. -Shipwright can support any tool that can build container images, such as [Kaniko](https://github.com/GoogleContainerTools/kaniko), -[Cloud Native Buildpacks](https://buildpacks.io/), and [Buildah](https://buildah.io/). See [default strategies](#build-strategies) for more information. +Shipwright supports any tool that can build container images in Kubernetes clusters, such as: + +- [Kaniko](https://github.com/GoogleContainerTools/kaniko) +- [Cloud Native Buildpacks](https://buildpacks.io/) +- [Buildah](https://buildah.io/) ## Try It! -* We assume you already have a Kubernetes cluster (v1.18+). If you don't, you can use Kind. +* We assume you already have a Kubernetes cluster (v1.18+). If you don't, you can use [Kind](/hack/install-kind.sh). * We also require a Tekton installation (v1.19+). To install the latest version, run: @@ -38,22 +45,22 @@ Shipwright can support any tool that can build container images, such as [Kaniko * Install the necessary deployments and strategies: ```bash - $ kubectl apply --filename https://github.com/shipwright-io/build/releases/download/v0.4.0/release.yaml - $ kubectl apply --filename https://github.com/shipwright-io/build/releases/download/v0.4.0/default_strategies.yaml + $ kubectl apply --filename https://github.com/shipwright-io/build/releases/download/nightly/nightly-2021-03-03-1614768199.yaml #TODO: we dont have an asset here + $ kubectl apply --filename https://github.com/shipwright-io/build/releases/download/v0.3.0/default_strategies.yaml #TODO: we dont have an asset here ``` -* Add a push secret to your container image repository, such as one on Docker Hub or quay.io: +* Generate a secret to access your container registry, such as one on [Docker Hub](https://hub.docker.com/) or [Quay.io](https://quay.io/): ```bash - $ kubectl create secret generic push-secret \ - --from-file=.dockerconfigjson=$HOME/.docker/config.json \ - --type=kubernetes.io/dockerconfigjson + $ REGISTRY_SERVER=https://index.docker.io/v1/ REGISTRY_USER=