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

Document current usage of zalando operator/other databases in a docs/database.md #124

Closed
zachariahmiller opened this issue May 6, 2024 · 0 comments
Closed

Document current usage of zalando operator/other databases in a docs/database.md #124

zachariahmiller opened this issue May 6, 2024 · 0 comments
Assignees
@Racer159
Labels
tech-debt 💳

Comments

@zachariahmiller
Copy link
Contributor

zachariahmiller commented May 6, 2024 •
edited
Loading

Describe what should be investigated or refactored

Documentation needs to be added to the SWF repo that describes how to integrate with the built in zalando operator, with RDS using IRSA and with username, password, connection string overrides. This should be package generic under ./docs/database.md

Then in each package repo that uses postgres, create a file ./docs/configuration.md (open to changing this name). That links to the SWF database doc in a database section and describes any package specific isms relating to DB connectivity

Example of how we do this with networking:
https://github.com/defenseunicorns/uds-package-gitlab/blob/main/docs/networking.md
@zachariahmiller zachariahmiller changed the title Clean up dev secrets to refelct current usage of zalando operator and add docs Clean up dev secrets to reflect current usage of zalando operator and add docs May 6, 2024
@oates oates changed the title Clean up dev secrets to reflect current usage of zalando operator and add docs Document current usage of zalando operator/other databases in a docs/database.md May 23, 2024
@Racer159 Racer159 mentioned this issue Jun 9, 2024
Merged
5 tasks
@Racer159 Racer159 self-assigned this Jun 9, 2024
Racer159 added a commit to defenseunicorns/uds-software-factory that referenced this issue Jun 12, 2024
@Racer159
chore: add docs for databases and networking configuration for apps (#62
8651574 
)

## Description

This centralizes documentation for networking configuration and adds
database configuration docs.

## Related Issue

Relates to
defenseunicorns/uds-package-gitlab#124

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Other (security config, docs update, etc)

## Checklist before merging

- [X] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/uds-software-factory/blob/main/CONTRIBUTING.md#developer-workflow)
followed
@Racer159 Racer159 reopened this Jun 12, 2024
@Racer159 Racer159 mentioned this issue Jun 12, 2024
Merged
5 tasks
Racer159 added a commit that referenced this issue Jun 14, 2024
@Racer159
chore: document how to use the database (#149)
3ec9044 
## Description

This adds a configuration.md for GitLab

## Related Issue

Relates to #124

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Other (security config, docs update, etc)

## Checklist before merging

- [X] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/uds-package-gitlab/blob/main/CONTRIBUTING.md#developer-workflow)
followed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Racer159 Racer159

Labels
tech-debt 💳
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Racer159 @zachariahmiller