Skip to content

Commit

Permalink
fixes broken links to sample examples
Browse files Browse the repository at this point in the history
  • Loading branch information
apoorvajagtap committed Sep 5, 2024
1 parent 5a2fc61 commit ca52c37
Show file tree
Hide file tree
Showing 41 changed files with 1,892 additions and 40 deletions.
2 changes: 1 addition & 1 deletion content/en/blog/posts/2022-04-14-build-release-v0.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ And that's not all, we have some smaller items that are worth to explore:

- We improved our sample build strategies to expose more parameters:
- Buildpacks now has a [`platform-api-version` parameter that allows to configure the `CNB_PLATFORM_API` version](https://github.com/shipwright-io/build/blob/v0.9.0/samples/buildstrategy/buildpacks-v3/buildstrategy_buildpacks-v3_cr.yaml#L8-L10) which is relevant to use features of newer Buildpacks implementations
- The BuildAh sample strategy now exposes its [parameters to configure default, blocked, and insecure registries as arrays](https://github.com/shipwright-io/build/blob/v0.9.0/samples/buildstrategy/buildah/buildstrategy_buildah_cr.yaml#L180-L193). It also supports [build-args](https://github.com/shipwright-io/build/blob/v0.9.0/samples/buildstrategy/buildah/buildstrategy_buildah_cr.yaml#L176-L179) in the same way as the BuildKit strategy.
- The BuildAh sample strategy now exposes its [parameters to configure default, blocked, and insecure registries as arrays](https://github.com/shipwright-io/build/blob/v0.9.0/samples/buildstrategy/buildah/buildstrategy_buildah_shipwright_managed_push_cr.yaml#L180-L193). It also supports [build-args](https://github.com/shipwright-io/build/blob/v0.9.0/samples/buildstrategy/buildah/buildstrategy_buildah_shipwright_managed_push_cr.yaml#L176-L179) in the same way as the BuildKit strategy.
- The BuildKit strategy now supports to build multi-platform images.
- We added [documentation about how to securely reference build strategy parameters in steps without allowing users to inject code in inline scripts](https://github.com/shipwright-io/build/blob/v0.9.0/docs/buildstrategies.md#securely-referencing-string-parameters). All sample build strategies are now secure.
- We added the `shp version` command to easily figure out which version of the command line interface is installed.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/build/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The `Build` definition supports the following fields:
- [`kind`](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields) - Specifies the Kind type, for example `Build`.
- [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields) - Metadata that identify the custom resource instance, especially the name of the `Build`, and in which [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) you place it. **Note**: You should use your own namespace, and not put your builds into the shipwright-build namespace where Shipwright's system components run.
- `spec.source` - Refers to the location of the source code, for example a Git repository or OCI artifact image.
- `spec.strategy` - Refers to the `BuildStrategy` to be used, see the [examples](../samples/v1beta1/buildstrategy)
- `spec.strategy` - Refers to the `BuildStrategy` to be used, see the [examples](./buildstrategies.md#available-clusterbuildstrategies)
- `spec.output`- Refers to the location where the generated image would be pushed.
- `spec.output.pushSecret`- Reference an existing secret to get access to the container registry.

Expand Down Expand Up @@ -299,7 +299,7 @@ In general, _paramValues_ are tightly bound to Strategy _parameters_. Please mak

#### Example

The [BuildKit sample `BuildStrategy`](../samples/v1beta1/buildstrategy/buildkit/buildstrategy_buildkit_cr.yaml) contains various parameters. Two of them are outlined here:
The [BuildKit sample BuildStrategy](https://github.com/shipwright-io/website/tree/main/content/en/docs/samples/buildstrategy/buildkit/buildstrategy_buildkit_cr.yaml) contains various parameters. Two of them are outlined here:

```yaml
apiVersion: shipwright.io/v1beta1
Expand Down
82 changes: 49 additions & 33 deletions content/en/docs/build/buildstrategies.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content/en/docs/build/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SPDX-License-Identifier: Apache-2.0
-->
## Controller Settings

The controller is installed into Kubernetes with reasonable defaults. However, there are some settings that can be overridden using environment variables in [`controller.yaml`](../deploy/500-controller.yaml).
The controller is installed into Kubernetes with reasonable defaults. However, there are some settings that can be overridden using environment variables in [`controller.yaml`](https://github.com/shipwright-io/build/blob/main/deploy/500-controller.yaml).

The following environment variables are available:

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/build/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export PROMETHEUS_BR_COMP_DUR_BUCKETS=30,60,90,120,180,240,300,360,420,480
make local
```

When you deploy the build controller in a Kubernetes cluster, you need to extend the `spec.containers[0].spec.env` section of the sample deployment file, [controller.yaml](../deploy/500-controller.yaml). Add an additional entry:
When you deploy the build controller in a Kubernetes cluster, you need to extend the `spec.containers[0].spec.env` section of the sample deployment file, [controller.yaml](https://github.com/shipwright-io/build/blob/main/deploy/500-controller.yaml). Add an additional entry:

```yaml
[...]
Expand Down Expand Up @@ -76,7 +76,7 @@ export PROMETHEUS_ENABLED_LABELS=buildstrategy,namespace,build
make local
```

When you deploy the build controller in a Kubernetes cluster, you need to extend the `spec.containers[0].spec.env` section of the sample deployment file, [controller.yaml](../deploy/controller.yaml). Add an additional entry:
When you deploy the build controller in a Kubernetes cluster, you need to extend the `spec.containers[0].spec.env` section of the sample deployment file, [controller.yaml](https://github.com/shipwright-io/build/blob/main/deploy/500-controller.yaml). Add an additional entry:

```yaml
[...]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildah-golang-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-go
contextDir: docker-build
strategy:
name: buildah-shipwright-managed-push
kind: ClusterBuildStrategy
paramValues:
- name: dockerfile
value: Dockerfile
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildah-golang-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-go
contextDir: docker-build
strategy:
name: buildah-strategy-managed-push
kind: ClusterBuildStrategy
paramValues:
- name: dockerfile
value: Dockerfile
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
24 changes: 24 additions & 0 deletions content/en/docs/samples/build/build_buildkit_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildkit-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-go
contextDir: docker-build
paramValues:
- name: platforms
values:
- value: linux/amd64
- value: linux/arm64
strategy:
name: buildkit
kind: ClusterBuildStrategy
retention:
atBuildDeletion: true
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app

16 changes: 16 additions & 0 deletions content/en/docs/samples/build/build_buildpacks-v3-heroku_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildpack-nodejs-build-heroku
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-nodejs
contextDir: source-build-heroku
strategy:
name: buildpacks-v3-heroku
kind: ClusterBuildStrategy
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildpack-nodejs-build-namespaced-heroku
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-nodejs
contextDir: source-build-heroku
strategy:
name: buildpacks-v3-heroku
kind: BuildStrategy
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
18 changes: 18 additions & 0 deletions content/en/docs/samples/build/build_buildpacks-v3_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildpack-nodejs-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-nodejs
contextDir: source-build
strategy:
name: buildpacks-v3
kind: ClusterBuildStrategy
retention:
atBuildDeletion: false
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: buildpack-nodejs-build-namespaced
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-nodejs
contextDir: source-build
strategy:
name: buildpacks-v3
kind: BuildStrategy
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
20 changes: 20 additions & 0 deletions content/en/docs/samples/build/build_kaniko-trivy-bad_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: kaniko-trivy-bad-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-scanning
strategy:
name: kaniko-trivy
kind: ClusterBuildStrategy
retention:
atBuildDeletion: true
paramValues:
- name: dockerfile
value: "Dockerfile.bad"
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/bad-trivy
20 changes: 20 additions & 0 deletions content/en/docs/samples/build/build_kaniko-trivy-good_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: kaniko-trivy-good-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-scanning
strategy:
name: kaniko-trivy
kind: ClusterBuildStrategy
retention:
atBuildDeletion: true
paramValues:
- name: dockerfile
value: "Dockerfile.good"
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/good-trivy
18 changes: 18 additions & 0 deletions content/en/docs/samples/build/build_kaniko_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: kaniko-golang-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-go
contextDir: docker-build
strategy:
name: kaniko
kind: ClusterBuildStrategy
retention:
atBuildDeletion: true
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/taxi-app
24 changes: 24 additions & 0 deletions content/en/docs/samples/build/build_ko_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: ko-build
spec:
paramValues:
- name: go-flags
value: "-v -mod=vendor -ldflags=-w"
- name: go-version
value: "1.21"
- name: package-directory
value: ./cmd/shipwright-build-controller
source:
type: Git
git:
url: https://github.com/shipwright-io/build
strategy:
name: ko
kind: ClusterBuildStrategy
retention:
atBuildDeletion: false
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/shipwright-build
19 changes: 19 additions & 0 deletions content/en/docs/samples/build/build_source-to-image_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
apiVersion: shipwright.io/v1beta1
kind: Build
metadata:
name: s2i-nodejs-build
spec:
source:
type: Git
git:
url: https://github.com/shipwright-io/sample-nodejs
contextDir: source-build/
strategy:
name: source-to-image
kind: ClusterBuildStrategy
paramValues:
- name: builder-image
value: "docker.io/centos/nodejs-10-centos7"
output:
image: image-registry.openshift-image-registry.svc:5000/build-examples/nodejs-ex
8 changes: 8 additions & 0 deletions content/en/docs/samples/buildrun/buildrun_buildah_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: buildah-golang-buildrun
spec:
build:
name: buildah-golang-build
9 changes: 9 additions & 0 deletions content/en/docs/samples/buildrun/buildrun_buildkit_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: buildkit-buildrun
spec:
build:
name: buildkit-build
serviceAccount: ".generate"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: buildpack-nodejs-buildrun-heroku
spec:
build:
name: buildpack-nodejs-build-heroku
serviceAccount: ".generate"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: buildpack-nodejs-buildrun-namespaced-heroku
spec:
build:
name: buildpack-nodejs-build-namespaced-heroku
serviceAccount: ".generate"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: buildpack-nodejs-buildrun
spec:
build:
name: buildpack-nodejs-build
serviceAccount: ".generate"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: buildpack-nodejs-buildrun-namespaced
spec:
build:
name: buildpack-nodejs-build-namespaced
serviceAccount: ".generate"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: kaniko-trivy-bad-buildrun
spec:
build:
name: kaniko-trivy-bad-build
serviceAccount: ".generate"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: kaniko-trivy-good-buildrun
spec:
build:
name: kaniko-trivy-good-build
serviceAccount: ".generate"
9 changes: 9 additions & 0 deletions content/en/docs/samples/buildrun/buildrun_kaniko_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: kaniko-golang-buildrun
spec:
build:
name: kaniko-golang-build
serviceAccount: ".generate"
9 changes: 9 additions & 0 deletions content/en/docs/samples/buildrun/buildrun_ko_cr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: ko-buildrun
spec:
build:
name: ko-build
serviceAccount: ".generate"
Loading

0 comments on commit ca52c37

Please sign in to comment.