docs: add documentation about syncing container images and air gap support #121
Conversation
README.md
Outdated
| @@ -43,6 +46,28 @@ $ charts-syncer sync --from-date 2020-05-15 | |||
|
|
|||
| > Date should be in format YYYY-MM-DD | |||
|
|
|||
| ## Advanced Usage | |||
|
|
|||
| #### Sync charts and container images | |||
There was a problem hiding this comment.
this should be ### right?
docs/airgap.md
Outdated
| kind: HELM | ||
| url: https://charts.trials.tac.bitnami.com/demo | ||
| target: | ||
| intermediateBundlesPath: /path/to/local/output-dir |
There was a problem hiding this comment.
I would use a real, usable, path (e.g. ., /tmp, or ./bundles if we are pre-creating the output folder in the tool)
docs/airgap.md
Outdated
|
|
||
| ```yaml | ||
| source: | ||
| intermediateBundlesPath: /path/to/local/input-dir |
docs/airgap.md
Outdated
| In some situations you may want to sync two Helm chart repositories without direct connectivity between them. | ||
| charts-syncer support this scenario via intermediate chart bundles. | ||
|
|
||
| An intermediate chart bundle is just a tarball containing the original chart code plus the container images needed to deploy the chart. |
There was a problem hiding this comment.
I'd add an additional paragraph here, something like.
This intermediate Chart Bundle enables a two-step process where its content will be used to relocate the container images and the rewritten Helm Chart without contacting the source Container images registry or Helm repository. Making the relocation process suitable for disconnected, air-gap target environments
docs/airgap.md
Outdated
|
|
||
| ## Step 1: Save chart bundles | ||
|
|
||
| In this first step charts-syncer needs access to the source charts repository. |
There was a problem hiding this comment.
source charts repository.
and container images registry
docs/airgap.md
Outdated
| url: https://charts.trials.tac.bitnami.com/demo | ||
| target: | ||
| intermediateBundlesPath: /path/to/local/output-dir | ||
| charts: |
There was a problem hiding this comment.
I'd not add the filter to the example, I'd just put the minimum required otherwise it can look that this is required when it's not
| - wordpress | ||
| ``` | ||
|
|
||
| Execute charts-syncer as follows: |
There was a problem hiding this comment.
s/as follows/as usual i.e/
The reason for this change is that it does not imply that's the only way to run it but that you can use any of the supported CLI options
docs/airgap.md
Outdated
|
|
||
| Move all the chart bundles from the machine with access to the source repo to the machine with access to the target repo. | ||
|
|
||
| You can do it however you want. |
There was a problem hiding this comment.
I'd remove this sentence, it sounds too informal.
docs/airgap.md
Outdated
|
|
||
| ## Step 3: Load chart bundles | ||
|
|
||
| In this first step charts-syncer needs access to the target charts repository. |
There was a problem hiding this comment.
and I'd explain what this step will do.
docs/airgap.md
Outdated
| charts-syncer sync --config ./config-load-bundles.yaml | ||
| ``` | ||
|
|
||
| Once charts-syncer finished preparing the bundles you will see them in the directory set in the `intermediateBundlesPath` |
tompizmor
force-pushed
the
airgap-documentation
branch
from
88b02e0 to
066d1f6
Compare
migmartri
force-pushed
the
airgap-documentation
branch
from
066d1f6 to
ce5603a
Compare
Just some basic documentation about the two recent features added to charts-syncer:
Closes #116