Skip to content

Commit 6fa6840

Browse files
Racer159Racer159
authored
chore: cleanup the repo (#34)
## Description This cleans up a few things noticed while creating https://github.com/defenseunicorns/uds-package-valkey ## Related Issue Fixes #N/A ## 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-postgres-operator/blob/main/CONTRIBUTING.md#developer-workflow) followed
1 parent dcec5ee commit 6fa6840

20 files changed

Lines changed: 59 additions & 54 deletions

‎CODEOWNERS‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
/* @defenseunicorns/uds
1+
# This repository is owned by the Software Factory Team
2+
/* @defenseunicorns/swf
3+
4+
# Additional privileged files
5+
/CODEOWNERS @jeff-mccoy @austenbryan
6+
/LICENSE @jeff-mccoy @austenbryan

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,5 @@
1-
# Welcome to the [NAME] UDS Capability
1+
# Welcome to the Postgres Operator UDS Package
22

3-
Thank you for your interest in this Defense Unicorns UDS Capability!
3+
Thank you for your interest in this Defense Unicorns UDS Package!
44

5-
This document describes the process and requirements for contributing to this UDS Capability.
6-
7-
## Developer Experience
8-
9-
Continuous Delivery is core to our development philosophy. Check out [https://minimumcd.org](https://minimumcd.org) for a good baseline agreement on what that means.
10-
11-
Specifically:
12-
13-
* We do trunk-based development (main) with short-lived feature branches that originate from the trunk, get merged into the trunk, and are deleted after the merge
14-
* We don't merge code into main that isn't releasable
15-
* We perform automated testing on all changes before they get merged to main
16-
* Continuous integration (CI) pipeline tests are definitive
17-
* We create immutable release artifacts
18-
19-
## Definition of Done
20-
21-
We apply these general principles to all User Stories and activities contributing to the UDS.
22-
23-
* Automated continuous integration (CI) pipeline tests pass
24-
* CI pipeline tests have been updated to meet system changes
25-
* Changes are peer reviewed
26-
* Acceptance criteria is met
27-
* Documentation is updated to reflect what changed
5+
This package is part of Defense Unicorns' UDS Software Factory and follows the contributing guidelines outlined in that repositories' [CONTRIBUTING.md](https://github.com/defenseunicorns/uds-software-factory/blob/main/CONTRIBUTING.md) file.

‎README.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# uds-package-postgres-operator
22

3-
> [!WARNING]
4-
> `uds-package-postgres-operator` is in early alpha and is not ready for general consumption.
5-
63
## Prerequisites
74

85
- [K3D](https://k3d.io/) for dev & test environments or any [CNCF Certified Kubernetes Cluster](https://www.cncf.io/training/certification/software-conformance/#logos) for production environments.
@@ -32,4 +29,4 @@ After installing uds-cli, for a list of available tasks that can be run in this
3229

3330
## Contributing
3431

35-
Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)
32+
Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)

‎SECURITY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Supported Versions
44

5-
As [UDS Software Factory](https://github.com/defenseunicorns/uds-package-postgres-operator) has not yet reached v1.0.0, only the current latest minor release is supported.
5+
As [UDS Software Factory](https://github.com/defenseunicorns/uds-software-factory) has not yet reached v1.0.0, only the current latest minor release is supported.
66

77
## Reporting a Vulnerability
88

‎adr/0001-record-architecture-decisions.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# 1. Record architecture decisions
2+
3+
Date: 2024-06-10
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
> NOTE:
12+
>
13+
> This file was automatically created when we used [adr-tools](https://github.com/npryce/adr-tools) to initialize the document log in the repo. ADRs on ADRs are a little silly, but it does give a lightweight way to direct the reader over to our contributor guide that has a lot more information.
14+
15+
We need to record the architectural decisions made on this project.
16+
17+
## Decision
18+
19+
We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), with a couple of small tweaks. See the [Documentation section in the Contributor guide](../CONTRIBUTING.md#documentation) for full details.
20+
21+
## Consequences
22+
23+
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

‎adr/template.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# NUMBER. TITLE
2+
3+
Date: DATE
4+
5+
## Status
6+
7+
STATUS
8+
9+
## Context
10+
11+
The issue motivating this decision, and any context that influences or constrains the decision.
12+
13+
## Decision
14+
15+
The change that we're proposing or have agreed to implement.
16+
17+
## Consequences
18+
19+
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.

‎chart/templates/peer-auth-exception.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ spec:
1313
portLevelMtls:
1414
"5432":
1515
mode: PERMISSIVE
16-
{{- end }}
16+
{{- end }}

‎chart/templates/postgres-minimal.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ spec:
1515
{{- toYaml .Values.postgresql.databases | nindent 4 }}
1616
postgresql:
1717
version: {{ .Values.postgresql.version | quote }}
18-
{{- end }}
18+
{{- end }}

‎chart/templates/postgres-svc.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ spec:
1414
type: ClusterIP
1515
selector:
1616
cluster-name: pg-cluster
17-
{{- end }}
17+
{{- end }}

‎chart/templates/uds-package.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ spec:
1111
remoteGenerated: IntraNamespace
1212
- direction: Egress
1313
remoteGenerated: IntraNamespace
14-
{{- if .Values.postgresql.ingress }}
14+
{{- if .Values.postgresql.ingress }}
1515
- direction: Ingress
1616
selector:
1717
cluster-name: pg-cluster
@@ -22,4 +22,3 @@ spec:
2222
cluster-name: pg-cluster
2323
remoteGenerated: KubeAPI
2424
{{- end }}
25-

0 commit comments

Comments
 (0)