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.

Sign up for GitHub

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

Jump to bottom

docs: document self-managed infrastructure #2458

Merged
merged 19 commits into from
Oct 23, 2023
Merged

docs: document self-managed infrastructure #2458

merged 19 commits into from
Oct 23, 2023

Conversation

msanft
Copy link
Contributor

@msanft msanft commented Oct 16, 2023 •
edited
Loading

Context

Self-managed infrastructure needs "MVP" documentation to be recognized as "supported". This PR documents the process of self-managed infrastructure very roughly but good enough for the general case. Specific cases (e.g. MAA-usage) differ in parts of what's described here, but are too specific to put into the main documentation.

Proposed change(s)

  • Add "MVP" documentation of self-managed infrastructure in Constellation.
  • Extend docs on how to fill the terraform.tfvars file when creating the resources with Terraform.

Additional info

Checklist

  • Update docs
  • Add labels (e.g., for changelog category)
  • Is PR title adequate for changelog?
  • Link to Milestone

@msanft msanft added the documentation Improvements or additions to documentation label Oct 16, 2023
@msanft msanft added this to the v2.13.0 milestone Oct 16, 2023
@msanft msanft requested review from 3u13r and daniel-weisse October 16, 2023 11:32
@msanft msanft requested a review from thomasten as a code owner October 16, 2023 11:32
@netlify
Copy link

netlify bot commented Oct 16, 2023 •
edited
Loading

✅ Deploy Preview for constellation-docs ready!

Name Link
🔨 Latest commit 005ad84
🔍 Latest deploy log https://app.netlify.com/sites/constellation-docs/deploys/65361a771757880007c7fdf6
😎 Deploy Preview https://deploy-preview-2458--constellation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

daniel-weisse
daniel-weisse reviewed Oct 16, 2023
View reviewed changes
docs/docs/getting-started/first-steps.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
@msanft msanft requested a review from daniel-weisse October 16, 2023 12:26
@msanft msanft mentioned this pull request Oct 17, 2023
Merged
3 tasks
thomasten
thomasten reviewed Oct 17, 2023
View reviewed changes
Copy link
Member

@thomasten thomasten left a comment

Choose a reason for hiding this comment

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

some nits and one question

docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
docs/docs/getting-started/first-steps.md Show resolved Hide resolved
@msanft msanft added the hold This cannot be merged right now label Oct 18, 2023
msanft added 2 commits October 18, 2023 10:51
@msanft
[broken] add docs for filling tfvars file
9b6998a 
Signed-off-by: Moritz Sanft <[email protected]>
@msanft
fix docs
d0b47d6 
Signed-off-by: Moritz Sanft <[email protected]>
@msanft msanft requested a review from thomasten October 18, 2023 09:24
@msanft msanft changed the title docs: add minimal docs for self-managed infrastructure docs: document self-managed infrastructure Oct 18, 2023
@msanft msanft removed the hold This cannot be merged right now label Oct 18, 2023
@msanft msanft requested a review from 3u13r October 18, 2023 09:26
3u13r
3u13r requested changes Oct 19, 2023
View reviewed changes
docs/docs/workflows/create.md Outdated Show resolved Hide resolved
@msanft
document endpoint separation
005ad84 
Signed-off-by: Moritz Sanft <[email protected]>
@msanft msanft requested a review from 3u13r October 23, 2023 07:02
3u13r
3u13r approved these changes Oct 23, 2023
View reviewed changes
Copy link
Member

@3u13r 3u13r left a comment

Choose a reason for hiding this comment

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

LGTM

@msanft msanft merged commit 19ca4e6 into main Oct 23, 2023
6 checks passed
@msanft msanft deleted the feat/docs/self-managed-infra branch October 23, 2023 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@3u13r 3u13r 3u13r approved these changes

@daniel-weisse daniel-weisse Awaiting requested review from daniel-weisse

@thomasten thomasten Awaiting requested review from thomasten thomasten is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v2.13.0
Development

Successfully merging this pull request may close these issues.
4 participants
@msanft @3u13r @thomasten @daniel-weisse