Skip to content

Commit

Permalink
maturity signals
Browse files Browse the repository at this point in the history
  • Loading branch information
balopat committed Nov 5, 2019
1 parent 00e3d81 commit 6288cd0
Show file tree
Hide file tree
Showing 16 changed files with 62 additions and 14 deletions.
2 changes: 1 addition & 1 deletion deploy/webhook/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ RUN git clone "${DOCSY_URL}" . && \

# Download Hugo
FROM alpine:3.10 as download-hugo
ENV HUGO_VERSION 0.58.3
ENV HUGO_VERSION 0.59.1
ENV HUGO_URL https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_Linux-64bit.tar.gz
RUN wget -O- "${HUGO_URL}" | tar xz

Expand Down
12 changes: 11 additions & 1 deletion docs/content/en/docs/design/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: "Skaffold API"
linkTitle: "Skaffold API"
weight: 60

maturity: alpha

infopanel: true
applicability: true
dev: true
debug: true
---
When running [`skaffold dev`]({{< relref "/docs/workflows/dev" >}}) or [`skaffold debug`]({{< relref "/docs/workflows/debug" >}}),
Skaffold starts a server that exposes an API over the lifetime of the Skaffold process.
Expand Down Expand Up @@ -81,6 +88,7 @@ Skaffold's API exposes the three main endpoints:
* Control API - control build/deploy/sync

### Events API
{{< alpha >}}

Skaffold provides a continuous development mode [`skaffold dev`]({{< relref "/docs/workflows/dev" >}}) which rebuilds and redeploys
your application on changes. In a single development loop, one or more container images
Expand Down Expand Up @@ -151,6 +159,7 @@ a string description of the event in `LogEntry.entry` field.


### State API
{{< beta >}}

The State API provides a snapshot of the current state of the following components:

Expand Down Expand Up @@ -224,6 +233,7 @@ func main() {
{{% /tab %}}
{{% /tabs %}}

### Controlling Build/Sync/Deploy
### Control API
{{< alpha >}}

TODO: https://github.com/GoogleContainerTools/skaffold/issues/3143
6 changes: 6 additions & 0 deletions docs/content/en/docs/design/global-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: "Global configuration"
linkTitle: "Global configuration"
weight: 50

maturity: beta

infopanel: true
applicability: true
all: true
---

Some context specific settings can be configured in a global configuration file, which defaults to `~/.skaffold/config`. Options can be configured globally or for specific Kubernetes contexts.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/docs/pipeline-stages/builders.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ title: "Build"
linkTitle: "Build"
weight: 10

maturity: GA

infoPanel: true
applicability: true
maturity: GA
dev: true
debug: true
build: true
Expand Down
4 changes: 3 additions & 1 deletion docs/content/en/docs/pipeline-stages/deployers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
title: "Deploy"
linkTitle: "Deploy"
weight: 30

maturity: GA

infoPanel: true
maturity: GA
applicability: true
dev: true
deploy: true
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/docs/pipeline-stages/filesync.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "File sync"
linkTitle: "File sync"
weight: 40

infoPanel: true
maturity: alpha

infoPanel: true
applicability: true
dev: true
---
Expand Down
4 changes: 3 additions & 1 deletion docs/content/en/docs/pipeline-stages/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
title: "Logging"
linkTitle: "Logging"
weight: 40

maturity: GA

infoPanel: true
applicability: true
maturity: GA
dev: true
debug: true
run: true
Expand Down
4 changes: 3 additions & 1 deletion docs/content/en/docs/pipeline-stages/port-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
title: "Port forwarding"
linkTitle: "Port forwarding"
weight: 50

maturity: beta

infoPanel: true
applicability: true
maturity: beta
dev: true
debug: true
---
Expand Down
4 changes: 3 additions & 1 deletion docs/content/en/docs/pipeline-stages/taggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
title: "Tag"
linkTitle: "Tag"
weight: 15

maturity: GA

infoPanel: true
applicability: true
maturity: GA
dev: true
debug: true
build: true
Expand Down
5 changes: 4 additions & 1 deletion docs/content/en/docs/pipeline-stages/testers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: "Test"
linkTitle: "Test"
weight: 20

maturity: beta

infoPanel: true
applicability: true
maturity: GA
dev: true
build: true
run: true
Expand Down
14 changes: 13 additions & 1 deletion docs/content/en/docs/workflows/ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
title: "CI/CD with Skaffold"
linkTitle: "CI/CD with Skaffold"
weight: 30

maturity: beta

infoPanel: true
applicability: true

build: true
deploy: true
render: true
run: true
---

Skaffold offers several sub-commands for its workflows that make it quite flexible when integrating with CI/CD pipelines.
Expand Down Expand Up @@ -46,7 +56,8 @@ Starting deploy...
- pod/getting-started configured
```

## `skaffold render`
## `skaffold render`
{{< alpha >}}

Skaffold also has another built-in command, `skaffold render`, that will perform builds on all artifacts in your project, template the newly built image tags into your Kubernetes deployment configuration files (based on your configured deployer), and instead of sending these through the deployment process, print out the final deployment artifacts. This allows your to snapshot your project's builds, but also integrate those builds into your deployment configs to snapshot your deployment as well. This can be very useful when integrating with GitOps based workflows: these templated deployment configurations can be committed to a Git repository as a way to deploy using GitOps.

Expand Down Expand Up @@ -86,3 +97,4 @@ pod/getting-started configured
```

## Waiting for Skaffold deployments using `healthcheck`
{{< beta >}}
7 changes: 3 additions & 4 deletions docs/content/en/docs/workflows/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
title: "Debugging with Skaffold"
linkTitle: "Debugging"
weight: 20
infoPanel: true

maturity: alpha

infoPanel: true
debug: true
applicability: true
---


## Debugging with Skaffold

`skaffold debug` acts like `skaffold dev`, but it configures containers in pods
for debugging as required for each container's runtime technology.
The associated debugging ports are exposed and labelled so that they can be port-forwarded to the
Expand Down
6 changes: 6 additions & 0 deletions docs/content/en/docs/workflows/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: "skaffold dev"
linkTitle: "Continuous development"
weight: 10

maturity: GA

infoPanel: true
applicability: true
dev: true
---

`skaffold dev` enables continuous local development on an application.
Expand Down
Empty file added docs/data/maturity.json
Empty file.
1 change: 1 addition & 0 deletions docs/layouts/shortcodes/alpha.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ $maturity := "alpha"}}<sup style="background: var(--maturity-{{$maturity}})">&nbsp;{{ $maturity}}&nbsp;</sup>
1 change: 1 addition & 0 deletions docs/layouts/shortcodes/beta.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ $maturity := "beta"}}<sup style="background: var(--maturity-{{$maturity}})">&nbsp;{{ $maturity}}&nbsp;</sup>

0 comments on commit 6288cd0

Please sign in to comment.