Skip to content

Commit

Permalink
preparing new release
Browse files Browse the repository at this point in the history
  • Loading branch information
Luis Davim committed Dec 29, 2019
1 parent 42fde3f commit 109361f
Show file tree
Hide file tree
Showing 19 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![GitHub version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh&type=6&v=v3.0.0-beta2&x2=0)](https://github.com/Praqma/helmsman/releases) [![CircleCI](https://circleci.com/gh/Praqma/helmsman/tree/master.svg?style=svg)](https://circleci.com/gh/Praqma/helmsman/tree/master)
[![GitHub version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh&type=6&v=v3.0.0-beta3&x2=0)](https://github.com/Praqma/helmsman/releases) [![CircleCI](https://circleci.com/gh/Praqma/helmsman/tree/master.svg?style=svg)](https://circleci.com/gh/Praqma/helmsman/tree/master)

![helmsman-logo](docs/images/helmsman.png)

Expand Down Expand Up @@ -61,9 +61,9 @@ If you use private helm repos, you will need either `helm-gcs` or `helm-s3` plug
Check the [releases page](https://github.com/Praqma/Helmsman/releases) for the different versions.
```
# on Linux
curl -L https://github.com/Praqma/helmsman/releases/download/v3.0.0-beta2/helmsman_3.0.0-beta1_linux_amd64.tar.gz | tar zx
curl -L https://github.com/Praqma/helmsman/releases/download/v3.0.0-beta3/helmsman_3.0.0-beta1_linux_amd64.tar.gz | tar zx
# on MacOS
curl -L https://github.com/Praqma/helmsman/releases/download/v3.0.0-beta2/helmsman_3.0.0-beta1_darwin_amd64.tar.gz | tar zx
curl -L https://github.com/Praqma/helmsman/releases/download/v3.0.0-beta3/helmsman_3.0.0-beta1_darwin_amd64.tar.gz | tar zx
mv helmsman /usr/local/bin/helmsman
```
Expand Down
2 changes: 1 addition & 1 deletion docs/best_practice.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Best Practice
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd_reference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# CMD reference
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment_strategies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Deployment Strategies
Expand Down Expand Up @@ -135,7 +135,7 @@ If you need supporting applications (charts) for your application (e.g, reverse

## Notes on using multiple Helmsman desired state files for the same cluster

Helmsman v3.0.0-beta2 introduces the `context` stanza.
Helmsman v3.0.0-beta3 introduces the `context` stanza.
When having multiple DSFs operating on different releases, it is essential to use the `context` stanza in each DSF to define what context the DSF covers. The user-provided value for `context` is used by Helmsman to label and distinguish which DSF manages which deployed releases in the cluster. This way, each helmsman operation will only operate on releases within the context defined in the DSF.

When having multiple DSFs be aware of the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/desired_state_specification.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Helmsman desired state specification
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/basic.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Install releases
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/destroy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Delete all deployed releases
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/helm_tests.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Test charts
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/moving_across_namespaces.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Move charts across namespaces
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/order.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Using the priority key for Apps
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/override_namespaces.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Override defined namespaces from command line
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/apps/secrets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Passing secrets from env variables:
Expand Down
4 changes: 2 additions & 2 deletions docs/how_to/deployments/ci.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Run Helmsman in CI
Expand All @@ -13,7 +13,7 @@ jobs:

deploy-apps:
docker:
- image: praqma/helmsman:v3.0.0-beta2
- image: praqma/helmsman:v3.0.0-beta3
steps:
- checkout
- run:
Expand Down
4 changes: 2 additions & 2 deletions docs/how_to/helm_repos/default.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Default helm repos

Helm v3 no longer adds the `stable` and `incubator` repos by default. However, Helmsman v3.0.0-beta2 still adds these two repos by default. These two DO NOT need to be defined explicitly in your desired state file (DSF). However, if you would like to configure some repo with the name stable for example, you can override the default repo.
Helm v3 no longer adds the `stable` and `incubator` repos by default. However, Helmsman v3.0.0-beta3 still adds these two repos by default. These two DO NOT need to be defined explicitly in your desired state file (DSF). However, if you would like to configure some repo with the name stable for example, you can override the default repo.

> You can disable the automatic addition of these two repos, use the `--no-default-repos` flag.
Expand Down
4 changes: 2 additions & 2 deletions docs/how_to/misc/merge_desired_state_files.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: v3.0.0-beta2
version: v3.0.0-beta3
---

# Supply multiple desired state files
Expand Down Expand Up @@ -47,7 +47,7 @@ $ helmsman -f common.toml -f nonprod.toml ...

When using multiple DSFs -and since Helmsman doesn't maintain any external state-, it has been possible for operations from one DSF to cause problems to releases deployed by other DSFs. A typical example is that releases deployed by other DSFs are considered `untracked` and get scheduled for deleting. Workarounds existed (e.g. using the `--keep-untracked-releases`, `--target` and `--group` flags).

Starting from Helmsman v3.0.0-beta2, `context` is introduced to define the context in which a DSF is used. This context is used as the ID of that specific DSF and must be unique across the used DSFs. The context is then used to label the different releases to link them to the DSF they were first deployed from. These labels are then checked by Helmsman on each run to make sure operations are limited to releases from a specific context.
Starting from Helmsman v3.0.0-beta3, `context` is introduced to define the context in which a DSF is used. This context is used as the ID of that specific DSF and must be unique across the used DSFs. The context is then used to label the different releases to link them to the DSF they were first deployed from. These labels are then checked by Helmsman on each run to make sure operations are limited to releases from a specific context.

Here is how it is used:

Expand Down
2 changes: 1 addition & 1 deletion examples/example.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# version: v3.0.0-beta2
# version: v3.0.0-beta3

# context defines the context of this Desired State File.
# It is used to allow Helmsman identify which releases are managed by which DSF.
Expand Down
2 changes: 1 addition & 1 deletion examples/example.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# version: v3.0.0-beta2
# version: v3.0.0-beta3
# metadata -- add as many key/value pairs as you want
metadata:
org: "example.com/$ORG_PATH/"
Expand Down
2 changes: 1 addition & 1 deletion internal/app/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func (i *stringArray) Set(value string) error {
return nil
}

const appVersion = "v3.0.0-beta2"
const appVersion = "v3.0.0-beta3"
const tempFilesDir = ".helmsman-tmp"
const stableHelmRepo = "https://kubernetes-charts.storage.googleapis.com"
const incubatorHelmRepo = "http://storage.googleapis.com/kubernetes-charts-incubator"
Expand Down
2 changes: 1 addition & 1 deletion release-notes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# v3.0.0-beta2
# v3.0.0-beta3

This is a major release to support Helm v3.
It is recommended you read the [Helm 3 migration guide](https://helm.sh/docs/topics/v2_v3_migration/) before using this release.
Expand Down

0 comments on commit 109361f

Please sign in to comment.