Skip to content

Commit

Permalink
chore: cleanup the repo (#34)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
Racer159 committed Jun 10, 2024
1 parent dcec5ee commit 6fa6840
Show file tree
Hide file tree
Showing 20 changed files with 59 additions and 54 deletions.
7 changes: 6 additions & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
/* @defenseunicorns/uds
# This repository is owned by the Software Factory Team
/* @defenseunicorns/swf

# Additional privileged files
/CODEOWNERS @jeff-mccoy @austenbryan
/LICENSE @jeff-mccoy @austenbryan
28 changes: 3 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,5 @@
# Welcome to the [NAME] UDS Capability
# Welcome to the Postgres Operator UDS Package

Thank you for your interest in this Defense Unicorns UDS Capability!
Thank you for your interest in this Defense Unicorns UDS Package!

This document describes the process and requirements for contributing to this UDS Capability.

## Developer Experience

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.

Specifically:

* 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
* We don't merge code into main that isn't releasable
* We perform automated testing on all changes before they get merged to main
* Continuous integration (CI) pipeline tests are definitive
* We create immutable release artifacts

## Definition of Done

We apply these general principles to all User Stories and activities contributing to the UDS.

* Automated continuous integration (CI) pipeline tests pass
* CI pipeline tests have been updated to meet system changes
* Changes are peer reviewed
* Acceptance criteria is met
* Documentation is updated to reflect what changed
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.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# uds-package-postgres-operator

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

- [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.
Expand Down Expand Up @@ -32,4 +29,4 @@ After installing uds-cli, for a list of available tasks that can be run in this

## Contributing

Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)
Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Supported Versions

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.
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.

## Reporting a Vulnerability

Expand Down
23 changes: 23 additions & 0 deletions adr/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 1. Record architecture decisions

Date: 2024-06-10

## Status

Accepted

## Context

> NOTE:
>
> 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.
We need to record the architectural decisions made on this project.

## Decision

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.

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
19 changes: 19 additions & 0 deletions adr/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# NUMBER. TITLE

Date: DATE

## Status

STATUS

## Context

The issue motivating this decision, and any context that influences or constrains the decision.

## Decision

The change that we're proposing or have agreed to implement.

## Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
2 changes: 1 addition & 1 deletion chart/templates/peer-auth-exception.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ spec:
portLevelMtls:
"5432":
mode: PERMISSIVE
{{- end }}
{{- end }}
2 changes: 1 addition & 1 deletion chart/templates/postgres-minimal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ spec:
{{- toYaml .Values.postgresql.databases | nindent 4 }}
postgresql:
version: {{ .Values.postgresql.version | quote }}
{{- end }}
{{- end }}
2 changes: 1 addition & 1 deletion chart/templates/postgres-svc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ spec:
type: ClusterIP
selector:
cluster-name: pg-cluster
{{- end }}
{{- end }}
3 changes: 1 addition & 2 deletions chart/templates/uds-package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ spec:
remoteGenerated: IntraNamespace
- direction: Egress
remoteGenerated: IntraNamespace
{{- if .Values.postgresql.ingress }}
{{- if .Values.postgresql.ingress }}
- direction: Ingress
selector:
cluster-name: pg-cluster
Expand All @@ -22,4 +22,3 @@ spec:
cluster-name: pg-cluster
remoteGenerated: KubeAPI
{{- end }}

5 changes: 0 additions & 5 deletions docs/DEVELOPMENT_MAINTENANCE.md

This file was deleted.

Empty file removed docs/adrs/.gitkeep
Empty file.
1 change: 0 additions & 1 deletion tasks.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
includes:
- cleanup: ./tasks/cleanup.yaml
- dependencies: ./tasks/dependencies.yaml
- test: ./tasks/test.yaml
- create: https://github.com/raw/defenseunicorns/uds-common/v0.4.5/tasks/create.yaml
Expand Down
10 changes: 0 additions & 10 deletions tasks/cleanup.yaml

This file was deleted.

4 changes: 2 additions & 2 deletions tasks/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ tasks:
- name: create-dbs
actions:
- description: Create the DB test package for the PG instance
cmd: uds zarf package create src/test --confirm --no-progress --architecture=${UDS_ARCH} --skip-sbom
cmd: uds zarf package create tests --confirm --no-progress --architecture=${UDS_ARCH} --skip-sbom --no-progress
- description: Deploy the test package into the cluster
cmd: uds zarf package deploy zarf-package-postgres-test-*.tar.zst --confirm
cmd: uds zarf package deploy zarf-package-postgres-test-${UDS_ARCH}-0.1.0.tar.zst --confirm --no-progress

- name: health-check
actions:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 6fa6840

Please sign in to comment.