Skip to content

Commit

Permalink
Generate adoc copies in /content/en/docs to shipwright-io#78
Browse files Browse the repository at this point in the history
  • Loading branch information
rolfedh committed May 25, 2022
1 parent 0e27a3b commit 5b0cd5d
Show file tree
Hide file tree
Showing 13 changed files with 1,432 additions and 1,096 deletions.
3 changes: 0 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,3 @@ PLATFORMS

DEPENDENCIES
asciidoctor (~> 2.0, >= 2.0.17)

BUNDLED WITH
2.3.7
21 changes: 18 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,13 @@ copyright = "The Shipwright Contributors"
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Releases"

# Flag used in the "version-banner" partial to decide whether to display a
# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version = "0.0"

Expand Down Expand Up @@ -137,7 +137,7 @@ yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/i
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false
Expand Down Expand Up @@ -186,3 +186,18 @@ enable = false
[security.http]
methods = ['(?i)GET|POST']
urls = ['.*']

[markup]
[markup.asciidocExt]
backend = 'html5'
extensions = []
failureLevel = 'fatal'
noHeaderOrFooter = true
preserveTOC = false
safeMode = 'unsafe'
sectionNumbers = false
trace = false
verbose = false
workingFolderCurrent = false
[markup.asciidocExt.attributes]
~
86 changes: 42 additions & 44 deletions content/en/docs/_index.md → content/en/docs/_index.adoc
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,62 +1,59 @@
---
title: "Documentation"
linkTitle: "Documentation"
draft: false
weight: 20
no_list: true
menu:
main:
weight: 20
---


= Documentation
:draft: false
:linkTitle: Documentation
:menu: {"main"=>{"weight"=>20}}
:no_list: true
:weight: 20

Shipwright is an extensible framework for building container images on Kubernetes.

Shipwright supports popular tools such as Kaniko, Cloud Native Buildpacks, Buildah, and more!

Shipwright is based around four elements for each build:

1. Source code - the "what" you are trying to build
1. Output image - "where" you are trying to deliver your application
1. Build strategy - "how" your application is assembled
1. Invocation - "when" you want to build your application
. Source code - the "what" you are trying to build
. Output image - "where" you are trying to deliver your application
. Build strategy - "how" your application is assembled
. Invocation - "when" you want to build your application

## Comparison with local image builds
== Comparison with local image builds

Developers who use Docker are familiar with this process:

1. Clone source from a git-based repository ("what")
2. Build the container image ("when" and "how")
. Clone source from a git-based repository ("what")
. Build the container image ("when" and "how")

```bash
[,bash]
----
docker build -t registry.mycompany.com/myorg/myapp:latest .
```
----

3. Push the container image to your registry ("where")
. Push the container image to your registry ("where")

```bash
[,bash]
----
docker push registry.mycompany.com/myorg/myapp:latest
```
----

## Shipwright Build APIs
== Shipwright Build APIs

Shipwright's Build API consists of four core
[CustomResourceDefinitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)
https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions[CustomResourceDefinitions]
(CRDs):

1. [`Build`](/docs/api/build/) - defines what to build, and where the application should be delivered.
1. [`BuildStrategy` and `ClusterBuildStrategy`](/docs/api/buildstrategies/) - defines how to build an application for an image
building tool.
1. [`BuildRun`](/docs/api/buildrun/) - invokes the build.
You create a `BuildRun` to tell Shipwright to start building your application.
. link:/docs/api/build/[`Build`] - defines what to build, and where the application should be delivered.
. link:/docs/api/buildstrategies/[`BuildStrategy` and `ClusterBuildStrategy`] - defines how to build an application for an image
building tool.
. link:/docs/api/buildrun/[`BuildRun`] - invokes the build.
You create a `BuildRun` to tell Shipwright to start building your application.

### Build
=== Build

The `Build` object provides a playbook on how to assemble your specific application. The simplest
build consists of a git source, a build strategy, and an output image:

```yaml
[,yaml]
----
apiVersion: build.dev/v1alpha1
kind: Build
metadata:
Expand All @@ -71,11 +68,11 @@ spec:
kind: ClusterBuildStrategy
output:
image: registry.mycompany.com/my-org/taxi-app:latest
```
----

Builds can be extended to push to private registries, use a different Dockerfile, and more.

### BuildStrategy and ClusterBuildStrategy
=== BuildStrategy and ClusterBuildStrategy

`BuildStrategy` and `ClusterBuildStrategy` are related APIs to define how a given tool should be
used to assemble an application. They are distinguished by their scope - `BuildStrategy` objects
Expand All @@ -85,7 +82,8 @@ The spec of a `BuildStrategy` or `ClusterBuildStrategy` consists of a `buildStep
specifications. Below is an example spec for Kaniko, which can build an image from a
Dockerfile within a container:

```yaml
[,yaml]
----
# this is a fragment of a manifest
spec:
buildSteps:
Expand Down Expand Up @@ -121,17 +119,17 @@ spec:
requests:
cpu: 250m
memory: 65Mi
```
----

### BuildRun
=== BuildRun

Each `BuildRun` object invokes a build on your cluster. You can think of these as a Kubernetes
`Jobs` or Tekton `TaskRuns` - they represent a workload on your cluster, ultimately resulting in a
running `Pod`. See [`BuildRun`](/docs/api/buildrun/) for more details.
running `Pod`. See link:/docs/api/buildrun/[`BuildRun`] for more details.

## Further reading
== Further reading

- [Configuration](/docs/configuration/)
- Build controller observability
- [Metrics](/docs/metrics/)
- [Profiling](/docs/profiling/)
* link:/docs/configuration/[Configuration]
* Build controller observability
** link:/docs/metrics/[Metrics]
** link:/docs/profiling/[Profiling]
Loading

0 comments on commit 5b0cd5d

Please sign in to comment.