You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -17,10 +17,10 @@ Thank you for your patience and trusting Helmsman with your tasks!
17
17
18
18
# How does it work?
19
19
20
-
Helmsman uses a simple declarative [TOML](https://github.com/toml-lang/toml) file to allow you to describe a desired state for your k8s applications as in the [example toml file](https://github.com/Praqma/helmsman/blob/master/examples/example.toml).
21
-
Alternatively YAML declaration is also acceptable [example yaml file](https://github.com/Praqma/helmsman/blob/master/examples/example.yaml).
20
+
Helmsman uses a simple declarative [TOML](https://github.com/toml-lang/toml) file to allow you to describe a desired state for your k8s applications as in the [example toml file](https://github.com/mkubaczyk/helmsman/blob/master/examples/example.toml).
21
+
Alternatively YAML declaration is also acceptable [example yaml file](https://github.com/mkubaczyk/helmsman/blob/master/examples/example.yaml).
22
22
23
-
The desired state file (DSF) follows the [desired state specification](https://github.com/Praqma/helmsman/blob/master/docs/desired_state_specification.md).
23
+
The desired state file (DSF) follows the [desired state specification](https://github.com/mkubaczyk/helmsman/blob/master/docs/desired_state_specification.md).
24
24
25
25
Helmsman sees what you desire, validates that your desire makes sense (e.g. that the charts you desire are available in the repos you defined), compares it with the current state of Helm and figures out what to do to make your desire come true.
26
26
@@ -78,15 +78,15 @@ Please make sure the following are installed prior to using `helmsman` as a bina
78
78
-[helm](https://github.com/helm/helm) (helm >=v2.10.0 for `helmsman` >= 1.6.0, helm >=v3.0.0 for `helmsman` >=v3.0.0)
If you use private helm repos, you will need either `helm-gcs` or `helm-s3` plugin or you can use basic auth to authenticate to your repos. See the [docs](https://github.com/Praqma/helmsman/blob/master/docs/how_to/helm_repos) for details.
81
+
If you use private helm repos, you will need either `helm-gcs` or `helm-s3` plugin or you can use basic auth to authenticate to your repos. See the [docs](https://github.com/mkubaczyk/helmsman/blob/master/docs/how_to/helm_repos) for details.
82
82
83
-
Check the [releases page](https://github.com/Praqma/Helmsman/releases) for the different versions.
83
+
Check the [releases page](https://github.com/mkubaczyk/helmsman/releases) for the different versions.
84
84
85
85
```sh
86
86
# on Linux
87
-
curl -L https://github.com/Praqma/helmsman/releases/download/v3.18.0/helmsman_3.18.0_linux_amd64.tar.gz | tar zx
87
+
curl -L https://github.com/mkubaczyk/helmsman/releases/download/v3.18.0/helmsman_3.18.0_linux_amd64.tar.gz | tar zx
88
88
# on MacOS
89
-
curl -L https://github.com/Praqma/helmsman/releases/download/v3.18.0/helmsman_3.18.0_darwin_amd64.tar.gz | tar zx
89
+
curl -L https://github.com/mkubaczyk/helmsman/releases/download/v3.18.0/helmsman_3.18.0_darwin_amd64.tar.gz | tar zx
-[As a binary with a hosted cluster](https://github.com/Praqma/helmsman/blob/master/docs/how_to/settings).
128
-
-[As a docker image in a CI system or local machine](https://github.com/Praqma/helmsman/blob/master/docs/how_to/deployments/ci.md) Always use a tagged docker image from [dockerhub](https://hub.docker.com/r/praqma/helmsman/) as the `latest` image can (at times) be unstable.
129
-
-[As a docker image inside a k8s cluster](https://github.com/Praqma/helmsman/blob/master/docs/how_to/deployments/inside_k8s.md)
127
+
-[As a binary with a hosted cluster](https://github.com/mkubaczyk/helmsman/blob/master/docs/how_to/settings).
128
+
-[As a docker image in a CI system or local machine](https://github.com/mkubaczyk/helmsman/blob/master/docs/how_to/deployments/ci.md) Always use a tagged docker image from [dockerhub](https://hub.docker.com/r/praqma/helmsman/) as the `latest` image can (at times) be unstable.
129
+
-[As a docker image inside a k8s cluster](https://github.com/mkubaczyk/helmsman/blob/master/docs/how_to/deployments/inside_k8s.md)
Copy file name to clipboardExpand all lines: docs/how_to/apps/basic.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ version: v3.0.0-beta5
6
6
7
7
## Install releases
8
8
9
-
You can run helmsman with the [example.toml](https://github.com/Praqma/helmsman/blob/master/examples/example.toml) or [example.yaml](https://github.com/Praqma/helmsman/blob/master/examples/example.yaml) file.
9
+
You can run helmsman with the [example.toml](https://github.com/mkubaczyk/helmsman/blob/master/examples/example.toml) or [example.yaml](https://github.com/mkubaczyk/helmsman/blob/master/examples/example.yaml) file.
Copy file name to clipboardExpand all lines: docs/how_to/apps/destroy.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,5 +8,5 @@ Helmsman allows you to delete all the helm releases that were deployed by Helmsm
8
8
9
9
The `--destroy` flag will remove all deployed releases from a given desired state file (DSF). Note that this does not currently delete the namespaces nor the Kubernetes contexts created.
10
10
11
-
This was originally requested in issue [#88](https://github.com/Praqma/helmsman/issues/88).
11
+
This was originally requested in issue [#88](https://github.com/mkubaczyk/helmsman/issues/88).
Copy file name to clipboardExpand all lines: docs/how_to/apps/lifecycle_hooks.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -139,11 +139,11 @@ You can do that by setting `deleteOnSuccess` to true in the `globalHooks` stanza
139
139
140
140
You can expand variables/parameters in the hook manifests at run time in one of the following ways:
141
141
142
-
- use env variables (defined as `$MY_VAR` in your manifests) and run helmsman with `--subst-env-values`. Environment variables can be read from the environment or you can [load them from an env file](https://github.com/Praqma/helmsman/blob/master/docs/how_to/apps/secrets.md#passing-secrets-from-env-files)
142
+
- use env variables (defined as `$MY_VAR` in your manifests) and run helmsman with `--subst-env-values`. Environment variables can be read from the environment or you can [load them from an env file](https://github.com/mkubaczyk/helmsman/blob/master/docs/how_to/apps/secrets.md#passing-secrets-from-env-files)
143
143
144
144
- use [AWS SSM parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) (defined as `{{ssm: MY_PARAM }}` in your manifests) and run helmsman with `--subst-ssm-values`.
145
145
146
-
- Pass encrypted values with [hiera-eyaml](https://github.com/Praqma/helmsman/blob/master/docs/how_to/settings/use-hiera-eyaml-as-secrets-encryption.md)
146
+
- Pass encrypted values with [hiera-eyaml](https://github.com/mkubaczyk/helmsman/blob/master/docs/how_to/settings/use-hiera-eyaml-as-secrets-encryption.md)
Copy file name to clipboardExpand all lines: docs/how_to/apps/override_context_from_cmd.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ version: v3.2.0
6
6
7
7
There are two main use cases for this flag:
8
8
9
-
1. To speed up Helmsman's execution when you have too many release (see [issue #418](https://github.com/Praqma/helmsman/issues/418))
9
+
1. To speed up Helmsman's execution when you have too many release (see [issue #418](https://github.com/mkubaczyk/helmsman/issues/418))
10
10
This flag works by skipping the search for the context information which Helmsman adds in the form of labels to the helm release state (secrets/configmaps).
11
11
12
12
> Use this option with caution. You must be sure that this won't cause conflicts.
Copy file name to clipboardExpand all lines: docs/how_to/misc/migrate_to_3.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ The migration process can go as follows:
16
16
> At this stage, Helm v3 can see and operate on your releases, but Helmsman can't. This is because Helmsman defined labels haven't been migrated to the Helm v3 releases state.
17
17
18
18
## Migrate to Helmsman v3.x
19
-
- Download the latest Helmsman v3.x release from [Github releases](https://github.com/Praqma/helmsman/releases)
20
-
- Modify your Helmsman's TOML/YAML desired state files (DSFs) to be Helmsman v3.x compatible. You can check [v3.0.0 release notes](https://github.com/Praqma/helmsman/blob/v3.0.0/release-notes.md) for what's changed and verify from the [Desired State Spec](https://github.com/Praqma/helmsman/blob/master/docs/desired_state_specification.md) that your DSF files are compatible.
19
+
- Download the latest Helmsman v3.x release from [Github releases](https://github.com/mkubaczyk/helmsman/releases)
20
+
- Modify your Helmsman's TOML/YAML desired state files (DSFs) to be Helmsman v3.x compatible. You can check [v3.0.0 release notes](https://github.com/mkubaczyk/helmsman/blob/v3.0.0/release-notes.md) for what's changed and verify from the [Desired State Spec](https://github.com/mkubaczyk/helmsman/blob/master/docs/desired_state_specification.md) that your DSF files are compatible.
21
21
22
22
> Everything related to Tiller will be removed from your DSFs at this stage.
0 commit comments