Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document our airgap example #1895

Merged
merged 1 commit into from
Feb 8, 2022
Merged

Conversation

carolynvs
Copy link
Member

@carolynvs carolynvs commented Feb 7, 2022

What does this change

Fully explain how to use the airgap example bundle to validate how Porter publishes bundles in airgapped environments.

What issue does it fix

People keep asking and I'm embarrassed that we haven't explained this better! 😅

Notes for the reviewer

I may back port some of this by hand to main, but since the example uses the porter credentials apply which is v1 only, maybe not?

I didn't try very hard to simulate a real airgapped deployment because I felt explaining how to set up a local cluster and registry to go with it is almost more work than the example.

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

@carolynvs carolynvs force-pushed the airgap-docs branch 2 times, most recently from a231562 to 3a6dc1a Compare February 7, 2022 18:45
Fully explain how to use the airgap example bundle to validate how
Porter publishes bundles in airgapped environments.

Signed-off-by: Carolyn Van Slyck <[email protected]>
@carolynvs carolynvs marked this pull request as ready for review February 7, 2022 19:26
4. Install the bundle referencing the new location of the bundle inside the airgapped network.

<figure>
<img src="/administrators/porter-airgap-publish.png" alt="a drawing showing two networks side by side, separated by an airgap. Network A has a docker registry with a copy of a bundle that includes the bundle.json, installer and the whalesayd image. An arrow labeled porter archive leads to a box with all those components in a single box labeled whalegap.tgz. Then another arrow labeled with a disc goes across the airgap, copying the same whalegap.tgz box wit its components into Network B. Then a final arrow labeled porter publish puts a copy of the bundle and its contents in Registry B, inside Network B."/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌 alt text on this img!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm super pumped about accessibility 🤓

@carolynvs carolynvs merged commit 0cc8e4f into getporter:release/v1 Feb 8, 2022
@carolynvs carolynvs deleted the airgap-docs branch February 8, 2022 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants