├── .adr-dir ├── .release-please-manifest.json ├── .gitignore ├── CODEOWNERS ├── bundles ├── dev │ ├── uds-config.yaml │ ├── README.md │ └── uds-bundle.yaml └── k3d-demo │ ├── uds-config.yaml │ ├── README.md │ └── uds-bundle.yaml ├── SECURITY.md ├── adr ├── template.md ├── 0001-record-architecture-decisions.md └── 0002-store-attestations-in-archivista.md ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ ├── tech_debt.md │ └── feature_request.md ├── pull_request_template.md └── workflows │ ├── commitlint.yaml │ ├── lint.yaml │ ├── ci-docs-shim.yaml │ ├── scorecard.yaml │ ├── release.yaml │ └── test.yaml ├── release-please-config.json ├── tasks └── test.yaml ├── .yamllint ├── LICENSING.md ├── docs ├── development.md ├── versioning.md ├── testing.md ├── networking.md └── database.md ├── renovate.json ├── tasks.yaml ├── CONTRIBUTING.md ├── README.md ├── CHANGELOG.md └── LICENSE.md /.adr-dir: -------------------------------------------------------------------------------- 1 | adr 2 | -------------------------------------------------------------------------------- /.release-please-manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | ".": "0.4.2" 3 | } 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | zarf-package-* 2 | uds-bundle-* 3 | zarf-sbom 4 | .vscode/ 5 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | # This repository is owned by the Software Factory Team 2 | /* @defenseunicorns/swf 3 | 4 | # Additional privileged files 5 | /CODEOWNERS @jeff-mccoy @daveworth 6 | /LICENS* @jeff-mccoy @austenbryan 7 | -------------------------------------------------------------------------------- /bundles/dev/uds-config.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | # Place your own variable settings here 5 | variables: 6 | -------------------------------------------------------------------------------- /bundles/k3d-demo/uds-config.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | # Place your own variable settings here 5 | variables: 6 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | As UDS Software Factory has not yet reached v1.0.0, only the current latest minor release is supported. 6 | 7 | ## Reporting a Vulnerability 8 | 9 | Please email `security-notice [at] defenseunicorns.com` to report a vulnerability. If you are unable to disclose details via email, please let us know and we can coordinate alternate communications. 10 | -------------------------------------------------------------------------------- /adr/template.md: -------------------------------------------------------------------------------- 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. 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: 'possible-bug 🐛' 6 | assignees: '' 7 | --- 8 | 9 | ### Environment 10 | Device and OS: 11 | App/package versions: 12 | Kubernetes distro being used: 13 | Other: 14 | 15 | ### Steps to reproduce 16 | 1. 17 | 18 | ### Expected result 19 | 20 | ### Actual Result 21 | 22 | ### Visual Proof (screenshots, videos, text, etc) 23 | 24 | ### Severity/Priority 25 | 26 | ### Additional Context 27 | Add any other context or screenshots about the technical debt here. 28 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | 3 | ... 4 | 5 | ## Related Issue 6 | 7 | Fixes # 8 | 9 | Relates to # 10 | 11 | ## Type of change 12 | 13 | - [ ] Bug fix (non-breaking change which fixes an issue) 14 | - [ ] New feature (non-breaking change which adds functionality) 15 | - [ ] Other (security config, docs update, etc) 16 | 17 | ## Checklist before merging 18 | 19 | - [ ] Test, docs, adr added or updated as needed 20 | - [ ] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-software-factory/blob/main/CONTRIBUTING.md#developer-workflow) followed 21 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/tech_debt.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Tech debt 3 | about: Record something that should be investigated or refactored in the future. 4 | title: '' 5 | labels: 'tech-debt 💳' 6 | assignees: '' 7 | --- 8 | 9 | ### Describe what should be investigated or refactored 10 | A clear and concise description of what should be changed/researched. Ex. This piece of the code is not DRY enough [...] 11 | 12 | ### Links to any relevant code 13 | (optional) i.e. - https://github.com/defenseunicorns/uds-software-factory/blob/main/README.md?plain=1#L1 14 | 15 | ### Additional context 16 | Add any other context or screenshots about the technical debt here. 17 | -------------------------------------------------------------------------------- /.github/workflows/commitlint.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | name: PR Title Check 5 | 6 | on: 7 | pull_request: 8 | branches: [main] 9 | types: [milestoned, opened, edited, synchronize] 10 | 11 | # Permissions for the GITHUB_TOKEN used by the workflow. 12 | permissions: 13 | contents: read # Allows reading the content of the repository. 14 | pull-requests: read # Allows reading pull requests 15 | 16 | jobs: 17 | validate: 18 | uses: defenseunicorns/uds-common/.github/workflows/callable-commitlint.yaml@19f816f55f0ddcd424bc51cb4d04e5720818ba5a # v1.8.0 19 | -------------------------------------------------------------------------------- /release-please-config.json: -------------------------------------------------------------------------------- 1 | { 2 | "packages": { 3 | ".": { 4 | "release-type": "simple", 5 | "draft": false, 6 | "changelog-path": "CHANGELOG.md", 7 | "changelog-sections": [ 8 | { "type": "feat", "section": "Features", "hidden": false }, 9 | { "type": "fix", "section": "Bug Fixes", "hidden": false }, 10 | { "type": "chore", "section": "Miscellaneous", "hidden": false } 11 | ], 12 | "versioning": "default", 13 | "extra-files": [ 14 | "README.md", 15 | "bundles/dev/uds-bundle.yaml", 16 | "bundles/k3d-demo/uds-bundle.yaml", 17 | "tasks.yaml" 18 | ] 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: 'enhancement ✨' 6 | assignees: '' 7 | --- 8 | 9 | ### Is your feature request related to a problem? Please describe. 10 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 11 | 12 | ### Describe the solution you'd like 13 | 14 | - **Given** a state 15 | - **When** an action is taken 16 | - **Then** something happens 17 | 18 | ### Describe alternatives you've considered 19 | (optional) A clear and concise description of any alternative solutions or features you've considered. 20 | 21 | ### Additional context 22 | Add any other context or screenshots about the feature request here. 23 | -------------------------------------------------------------------------------- /tasks/test.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | includes: 5 | - mm: https://raw.githubusercontent.com/defenseunicorns/uds-package-mattermost/v10.4.2-uds.0/tasks/test.yaml 6 | - gl: https://raw.githubusercontent.com/defenseunicorns/uds-package-gitlab/v17.6.2-uds.0/tasks/test.yaml 7 | - sq: https://raw.githubusercontent.com/defenseunicorns/uds-package-sonarqube/25.1.0.102122-uds.0-registry1/tasks/test.yaml 8 | - glr: https://raw.githubusercontent.com/defenseunicorns/uds-package-gitlab-runner/v17.2.1-uds.6/tasks/test.yaml 9 | 10 | tasks: 11 | - name: all 12 | description: Run ingress tests 13 | actions: 14 | - task: mm:ingress 15 | - task: gl:ingress 16 | - task: sq:ingress 17 | -------------------------------------------------------------------------------- /.github/workflows/lint.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | name: Lint 5 | 6 | on: 7 | # This workflow is triggered on pull requests to the main branch. 8 | pull_request: 9 | # milestoned is added here as a workaround for release-please not triggering PR workflows (PRs should be added to a milestone to trigger the workflow). 10 | types: [milestoned, opened, reopened, synchronize] 11 | 12 | # Permissions for the GITHUB_TOKEN used by the workflow. 13 | permissions: 14 | contents: read # Allows reading the content of the repository. 15 | 16 | jobs: 17 | validate: 18 | uses: defenseunicorns/uds-common/.github/workflows/callable-lint.yaml@19f816f55f0ddcd424bc51cb4d04e5720818ba5a # v1.8.0 19 | secrets: inherit 20 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | yaml-files: 2 | - '**/*.y*ml' 3 | - '.yamllint' 4 | 5 | ignore: 6 | - '**/.terraform/**' 7 | - '**/chart/templates**' 8 | 9 | rules: 10 | anchors: enable 11 | braces: enable 12 | brackets: enable 13 | colons: enable 14 | commas: enable 15 | comments: 16 | level: warning 17 | comments-indentation: 18 | level: warning 19 | document-end: disable 20 | document-start: 21 | level: warning 22 | empty-lines: enable 23 | empty-values: disable 24 | float-values: disable 25 | hyphens: enable 26 | indentation: enable 27 | key-duplicates: enable 28 | key-ordering: disable 29 | line-length: disable 30 | new-line-at-end-of-file: enable 31 | new-lines: enable 32 | octal-values: disable 33 | quoted-strings: disable 34 | trailing-spaces: enable 35 | truthy: 36 | level: warning 37 | -------------------------------------------------------------------------------- /.github/workflows/ci-docs-shim.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | name: CI Doc Shim 5 | 6 | on: 7 | pull_request: 8 | branches: [main] 9 | types: [milestoned, opened, synchronize] 10 | 11 | # Permissions for the GITHUB_TOKEN used by the workflow. 12 | permissions: 13 | contents: read # Allows reading the content of the repository. 14 | 15 | jobs: 16 | run: 17 | strategy: 18 | matrix: 19 | bundle: [k3d-demo, dev] 20 | type: [install, upgrade] 21 | runs-on: ubuntu-latest 22 | timeout-minutes: 20 23 | steps: 24 | - name: Shim for ${{ matrix.type }} ${{ matrix.bundle }} 25 | run: | 26 | echo "Documentation-only change detected; marking ${{ matrix.type }} ${{ matrix.bundle }} as successful." 27 | -------------------------------------------------------------------------------- /LICENSING.md: -------------------------------------------------------------------------------- 1 | # Dual Licensing 2 | 3 | This software is licensed under either of: 4 | 5 | - GNU Affero General Public License v3.0 (AGPLv3), see [LICENSE.md](./LICENSE.md) 6 | - Defense Unicorns Commercial License, see below 7 | 8 | ## Defense Unicorns Commercial License 9 | 10 | The use of this software under a commercial license is subject to the individual 11 | terms of the license agreement between the licensee and Defense Unicorns. The 12 | content of this license depends on the specific agreement and may vary. For 13 | more information about obtaining a commercial license, please contact 14 | Defense Unicorns at [defenseunicorns.com](https://defenseunicorns.com). 15 | 16 | To use this software under the commercial license, you must have a valid license 17 | agreement with Defense Unicorns. The terms of the Defense Unicorns, Inc. license 18 | agreement supplant and supersede the terms of the AGPL v3 license. 19 | -------------------------------------------------------------------------------- /adr/0001-record-architecture-decisions.md: -------------------------------------------------------------------------------- 1 | # 1. Record architecture decisions 2 | 3 | Date: 2024-02-04 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). 24 | -------------------------------------------------------------------------------- /bundles/dev/README.md: -------------------------------------------------------------------------------- 1 | # UDS Software Factory Dev Bundle 2 | 3 | ## Bundle Applications 4 | 5 | - [GitLab](https://github.com/defenseunicorns/uds-package-gitlab) - a DevOps software package that can develop, secure, and operate software 6 | - [GitLab Runner](https://github.com/defenseunicorns/uds-package-gitlab-runner) - a Continuous Integration runner that integrates with GitLab 7 | - [Renovate](https://github.com/defenseunicorns/uds-package-renovate) - a dependency checking bot that integrates with GitLab 8 | - [Mattermost](https://github.com/defenseunicorns/uds-package-mattermost) - an open-source, self-hostable online chat service 9 | - [SonarQube](https://github.com/defenseunicorns/uds-package-sonarqube) - an open-source platform developed by SonarSource for continuous inspection of code quality 10 | - [Postgres Operator](https://github.com/defenseunicorns/uds-package-postgres-operator) - a Kubernetes operator to deploy PostgreSQL databases in a cluster 11 | - [Minio](https://min.io/) - In-cluster S3 Object Storage (note this is not yet `uds-package-minio-operator`) 12 | -------------------------------------------------------------------------------- /.github/workflows/scorecard.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | name: Scorecards supply-chain security 5 | on: 6 | # Only the default branch is supported. 7 | branch_protection_rule: 8 | schedule: 9 | - cron: '30 1 * * 6' 10 | push: 11 | branches: ["main"] 12 | 13 | # Declare default permissions as read only. 14 | permissions: read-all 15 | 16 | jobs: 17 | validate: 18 | permissions: 19 | actions: read 20 | attestations: read 21 | checks: read 22 | contents: read 23 | deployments: read 24 | discussions: read 25 | issues: read 26 | packages: read 27 | pages: read 28 | pull-requests: read 29 | repository-projects: read 30 | statuses: read 31 | # Needed to upload the results to code-scanning dashboard. 32 | security-events: write 33 | # Used to receive a badge. 34 | id-token: write 35 | uses: defenseunicorns/uds-common/.github/workflows/callable-scorecard.yaml@19f816f55f0ddcd424bc51cb4d04e5720818ba5a # v1.8.0 36 | secrets: inherit 37 | -------------------------------------------------------------------------------- /docs/development.md: -------------------------------------------------------------------------------- 1 | # Development Quickstart 2 | 3 | ## Apple Silicon Mac Users 4 | 5 | If deploying on an Apple Silicon Mac you can use colima, an open source alternative to Docker Desktop, to deploy this bundle. Colima can be installed via Homebrew by running ```brew install colima```. 6 | 7 | To set up an appropriately configured colima VM you can run the following command: 8 | 9 | ```bash 10 | colima start --cpu 9 --memory 28 --disk 50 --vm-type vz --vz-rosetta --arch aarch64 --profile uds 11 | ``` 12 | 13 | Additionally, some settings need to be configured on the host to facilitate a successful deployment of Sonarqube: 14 | 15 | ```bash 16 | colima ssh --profile uds 17 | sudo sysctl -w vm.max_map_count=1524288 18 | sudo sysctl -w fs.file-max=1000000 19 | exit 20 | ``` 21 | 22 | ## Linux users 23 | 24 | Depending on your linux distribution and how it is configured you may need to run the following steps to be able to properly deploy SWF and/or UDS Core: 25 | 26 | ```bash 27 | sudo sysctl -w vm.max_map_count=1524288 28 | sudo sysctl -w fs.file-max=1000000 29 | ulimit -n 1000000 30 | ulimit -u 8192 31 | sudo sysctl --load 32 | sudo swapoff -a 33 | sudo sysctl fs.inotify.max_user_instances=8192 34 | sudo sysctl -p 35 | ``` 36 | -------------------------------------------------------------------------------- /bundles/k3d-demo/README.md: -------------------------------------------------------------------------------- 1 | # UDS Software Factory K3d Demo Bundle 2 | 3 | ## Bundle Applications 4 | 5 | - [UDS-K3d](https://k3d.io/) - Containerized K3s with opinionated deployment for UDS development 6 | - [UDS Core](https://github.com/defenseunicorns/uds-core) - Service Mesh, IdAM, Monitoring, Logging, Metrics, UDS Policy Engine & Operator, Container Security, Backup and Restore 7 | - [GitLab](https://github.com/defenseunicorns/uds-package-gitlab) - a DevOps software package that can develop, secure, and operate software 8 | - [GitLab Runner](https://github.com/defenseunicorns/uds-package-gitlab-runner) - a Continuous Integration runner that integrates with GitLab 9 | - [Renovate](https://github.com/defenseunicorns/uds-package-renovate) - a dependency checking bot that integrates with GitLab 10 | - [Mattermost](https://github.com/defenseunicorns/uds-package-mattermost) - an open-source, self-hostable online chat service 11 | - [SonarQube](https://github.com/defenseunicorns/uds-package-sonarqube) - an open-source platform developed by SonarSource for continuous inspection of code quality 12 | - [Postgres Operator](https://github.com/defenseunicorns/uds-package-postgres-operator) - a Kubernetes operator to deploy PostgreSQL databases in a cluster 13 | - [Valkey](https://github.com/defenseunicorns/uds-package-valkey) - a Redis-alternative that can be deployed in a cluster (intended for use with GitLab) 14 | - [Minio](https://min.io/) - In-cluster S3 Object Storage (note this is not yet `uds-package-minio-operator`) 15 | -------------------------------------------------------------------------------- /adr/0002-store-attestations-in-archivista.md: -------------------------------------------------------------------------------- 1 | # 1. Store In-Toto Attestations in Archivista 2 | 3 | Date: 2024-07-09 4 | 5 | ## Status 6 | 7 | Accepted 8 | 9 | ## Context 10 | 11 | During execution of Software Factory pipelines, we will be generating [in-toto attestations](https://github.com/in-toto/attestation) using [Witness](https://github.com/in-toto/witness) for the artifacts that are produced. We need a location to store these attestations so that they can later be retrieved and used to verify an artifact against policies. 12 | 13 | ## Decision 14 | 15 | We will use [Archivista](https://github.com/in-toto/archivista) to store the attestations. Archivista is also an in-toto project and integrates easily with Witness to store, retrieve, and verify attestations. 16 | 17 | In addition, Archivista maintains a graph of metadata for the attestations, allowing attestations to be associated to all build artifacts. All that is needed to run a verification is an artifact and the Witness CLI, and the other data will be automatically retrieved from Archivista. 18 | 19 | Policies can also be stored in Archivista, though this feature set isn't as mature yet. 20 | 21 | ## Alternatives considered 22 | 23 | We could configure Witness to produce json files to the filesystem and store the files in a file storage solution ourselves. However, we would have to maintain an association between all the build artifacts and the correct files, and be able to retrieve the correct attestation file for the correct artifact at verification time. Archivista handles this for us and is lightweight and already in the in-toto family of tools. 24 | 25 | ## Consequences 26 | 27 | We will need to create and maintain a new UDS package for Archivista: [uds-package-archivista](https://github.com/defenseunicorns/uds-package-archivista). 28 | 29 | Archivista stores the attestations in an S3 compatible blob storage and the metadata in an RDBMS (MySQL or Postgres). We will need to test backup and restore mechanisms for both of these. 30 | -------------------------------------------------------------------------------- /docs/versioning.md: -------------------------------------------------------------------------------- 1 | # Versioning 2 | 3 | > :warning: **Note:** Packages are the only production release artifacts published from the UDS Software Factory repositories, as bundles are meant to be _created_, not consumed, by users. Repos may publish bundles for demo purposes, but those are not intended for production consumption though will loosely follow standard semantic versioning. 4 | 5 | ## Versioning 6 | 7 | UDS Software Factory `packages` are versioned as follows: 8 | 9 | ``` 10 | -uds. 11 | ``` 12 | 13 | Where, 14 | 15 | - `upstream-app-version`: is the version of the main application in the package (i.e. `16.9.2` for GitLab) 16 | - `uds-sub-version`: is the number of releases since the last main application version bump (starting at `0`) 17 | 18 | In practice, this results in the following for the second release of a `package` for version `16.9.2` of GitLab: 19 | 20 | ``` 21 | 16.9.2-uds.1 22 | ``` 23 | 24 | ## Releases 25 | 26 | Releases themselves are cut with [Release Please](https://github.com/googleapis/release-please), but due to the fact that we don't follow semantic versioning precisely, specific version numbers are manually bumped in the release please PRs or via [empty commits](https://github.com/googleapis/release-please). Specific lines to update within `zarf.yaml` or `uds-bundle.yaml` files are controlled via the following: 27 | 28 | ```yaml 29 | # x-release-please-start-version 30 | version: "0.2.1" 31 | # x-release-please-end 32 | ``` 33 | 34 | Once a release is cut by merging a release-please PR, a GitHub action takes over and publishes the resulting package to `ghcr.io/defenseunicorns/packages` where it is available in Zarf and UDS CLI via the `defenseunicorns` and `🦄` shorthands. 35 | 36 | > :warning: **Note:** If a release is broken or has known issues that the team feels are severe enough, the `CHANGELOG.md` and GitHub release notes should be updated denoting those facts, and a new release should be issued as soon as the team is able. 37 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "github>defenseunicorns/uds-common//config/renovate.json5", 4 | ":semanticCommits", 5 | ":semanticPrefixFixDepsChoreOthers", 6 | "group:all", 7 | "replacements:all", 8 | "workarounds:all" 9 | ], 10 | "schedule": [ 11 | "after 7am and before 9am every weekday" 12 | ], 13 | "packageRules": [ 14 | { 15 | "groupName": "SWF Support Dependencies", 16 | "labels": [ 17 | "support-deps" 18 | ], 19 | "commitMessageTopic": "support-deps", 20 | "matchPackageNames": [ 21 | "*" 22 | ] 23 | }, 24 | { 25 | "groupName": "SWF Bundle Dependencies", 26 | "labels": [ 27 | "bundle-deps" 28 | ], 29 | "commitMessageTopic": "bundle-deps", 30 | "matchDatasources": [ 31 | "docker", 32 | "helm", 33 | "git-tags", 34 | "github-tags" 35 | ] 36 | } 37 | ], 38 | "customManagers": [ 39 | { 40 | "customType": "regex", 41 | "depNameTemplate": "defenseunicorns/uds-core", 42 | "fileMatch": [ 43 | "README\\.md" 44 | ], 45 | "matchStrings": [ 46 | "k3d-core-slim-dev:(?.*)" 47 | ], 48 | "datasourceTemplate": "github-tags", 49 | "extractVersionTemplate": "^v(?.*)$" 50 | }, 51 | { 52 | "customType": "regex", 53 | "depNameTemplate": "defenseunicorns/uds-cli", 54 | "fileMatch": [ 55 | "README\\.md" 56 | ], 57 | "matchStrings": [ 58 | "UDS CLI[^\\s]*(?[^\\s]*)" 59 | ], 60 | "datasourceTemplate": "github-tags", 61 | "extractVersionTemplate": "^v(?.*)$" 62 | }, 63 | { 64 | "customType": "regex", 65 | "fileMatch": [ 66 | ".*(\\.ya?ml|\\.json)$" 67 | ], 68 | "matchStrings": [ 69 | "https:\\/\\/raw\\.githubusercontent\\.com\\/(?[^\\/]+\\/[^\\/]+)\\/(?[^\\/]+)" 70 | ], 71 | "versioningTemplate": "regex:^v?(?\\d+)(\\.(?\\d+))?(\\.(?\\d+))?(-uds\\.(?\\d))?(-(?\\w+)?)?(.*?)?$", 72 | "datasourceTemplate": "github-tags" 73 | } 74 | ] 75 | } 76 | -------------------------------------------------------------------------------- /docs/testing.md: -------------------------------------------------------------------------------- 1 | # Testing 2 | 3 | Currently we test the UDS Software Factory at two different levels, the overall `bundle`, and the individual `package`. Each level has different tests that it performs in order to save time while still ensuring that the necessary configurations are covered. 4 | 5 | ## Bundle Testing 6 | 7 | Bundle testing is performed in the main [UDS Software Factory repository](https://github.com/defenseunicorns/uds-software-factory/) and tests the following: 8 | 9 | 1. Overall health of each package within the deployment 10 | 2. Integration of individual packages with each other 11 | 3. Integration of packages with all of `uds-core` 12 | 4. Integration of packages with clusters beyond `k3d` 13 | 14 | It does not test: 15 | 16 | 1. Upgrades of individual packages 17 | 2. Package flavors other than `upstream` 18 | 19 | ## Package Testing 20 | 21 | Package testing is performed in each package repository and tests the following: 22 | 23 | 1. Health of the Package deployment (including its individual components) 24 | 2. Package upgrades from the previous version to the current version 25 | 3. The full matrix of package flavors 26 | 4. Integration of a package with `k3d-core-istio` 27 | 28 | It does not test: 29 | 30 | 1. Integration between SWF packages (with the exception of add-ons like GitLab Runner) 31 | 2. Integration of a package with all of `uds-core` 32 | 3. Integration of packages with clusters beyond `k3d` 33 | 34 | > :warning: **Note:** In order to ensure that we can be reasonably confident in the above, package flavors should deviate only by their selected _images_ and not by other configuration like their Helm Chart. This ensures that when we test the images with the given chart / configuration and then test that configuration within a bundle, we can be reasonably certain that each combination of flavors would work within the bundle. 35 | 36 | ## Running Tests 37 | 38 | In order to keep them portable, tests at all levels will be implemented as `uds` tasks that create the necessary packages/bundles, setup the cluster, deploy the packages/bundles and then perform the necessary checks on them. These will then be wrapped in GitHub actions to run on Pull Requests / Releases. 39 | 40 | > :warning: **Note:** You can see the list of available tasks in a given repository by running `uds run --list` at the repository root. 41 | -------------------------------------------------------------------------------- /docs/networking.md: -------------------------------------------------------------------------------- 1 | # Networking 2 | 3 | Software Factory applications are configured by default to assume they will connect to the internal dependencies that are used for testing (see examples such as `storage`, `redis` and `postgres` in a given `bundle/uds-bundle.yaml`). This is intentional, so as to not create overly permissive network policies by default. For example, there is not a default setup of egress anywhere for pods that may need to connect to external storage. 4 | 5 | > [!IMPORTANT] 6 | > If you are using different internal services, cloud services or a mix you **MUST** configure values in the given config chart accordingly via bundle overrides. A couple of example are provided below. 7 | 8 | Configure an application with external services: 9 | 10 | ```yaml 11 | # charts/config/values.yaml 12 | storage: 13 | internal: false 14 | redis: 15 | internal: false 16 | postgres: 17 | internal: false 18 | ``` 19 | 20 | Configure an application with external postgres and s3, but in-cluster redis: 21 | 22 | ```yaml 23 | # charts/config/values.yaml 24 | storage: 25 | internal: false 26 | postgres: 27 | internal: false 28 | redis: 29 | internal: true 30 | selector: 31 | app.kubernetes.io/name: redis 32 | namespace: redis 33 | port: 6379 34 | ``` 35 | 36 | > [!TIP] 37 | > There may be a need to integrate with other in-cluster services that are not a part of the standard connectivity needed by the application (as an example a Jira integration with GitLab). As such, Software Factory applications provide the ability to add custom rules to allow additional internal network connectivity. 38 | 39 | Add custom rule: 40 | 41 | ```yaml 42 | # charts/config/values.yaml 43 | custom: 44 | # Notice no `remoteGenerated` field here on custom internal rule 45 | - direction: Ingress 46 | selector: 47 | app: webservice 48 | remoteNamespace: jira 49 | remoteSelector: 50 | app: jira 51 | port: 8180 52 | description: "Ingress from Jira" 53 | # No `remoteNamespace`, `remoteSelector`, or `port` fields on rule to `remoteGenerated` 54 | - direction: Egress 55 | selector: 56 | app: webservice 57 | remoteGenerated: Anywhere 58 | description: "Egress from Webservice" 59 | ``` 60 | 61 | > [!NOTE] 62 | > The above is just an example of what can be done with the custom key and not representative what any specific integration would need to look like. 63 | -------------------------------------------------------------------------------- /.github/workflows/release.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | name: Release 5 | 6 | on: 7 | push: 8 | branches: 9 | - main 10 | 11 | # Permissions for the GITHUB_TOKEN used by the workflow. 12 | permissions: 13 | contents: read # Allows reading the content of the repository. 14 | packages: read # Allows reading the content of the repository's packages. 15 | id-token: write 16 | 17 | jobs: 18 | tag-new-version: 19 | permissions: write-all 20 | runs-on: ubuntu-latest 21 | outputs: 22 | release_created: ${{ steps.release-flag.outputs.release_created }} 23 | steps: 24 | - name: Create Release Tag 25 | id: tag 26 | uses: googleapis/release-please-action@7987652d64b4581673a76e33ad5e98e3dd56832f # v4.1.3 27 | - id: release-flag 28 | run: echo "release_created=${{ steps.tag.outputs.release_created || false }}" >> "$GITHUB_OUTPUT" 29 | 30 | publish: 31 | permissions: 32 | contents: write # Allows writing the content of the repository. 33 | packages: write # Allows writing the content of the repository's packages. 34 | id-token: write 35 | needs: tag-new-version 36 | if: ${{ needs.tag-new-version.outputs.release_created == 'true' }} 37 | strategy: 38 | matrix: 39 | bundle: [k3d-demo, dev] 40 | architecture: [amd64, arm64] 41 | runs-on: ${{ matrix.architecture == 'arm64' && 'uds-swf-ubuntu-arm64-4-core' || 'uds-swf-ubuntu-big-boy-16-core' }} 42 | timeout-minutes: 80 43 | 44 | steps: 45 | - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 46 | 47 | - name: Install UDS CLI 48 | uses: defenseunicorns/setup-uds@ab842abcad1f7a3305c2538e3dd1950d0daacfa5 # v1.0.1 49 | with: 50 | # renovate: datasource=github-tags depName=defenseunicorns/uds-cli versioning=semver 51 | version: v0.21.0 52 | 53 | - name: Environment setup 54 | run: | 55 | uds run actions:setup-environment \ 56 | --set REGISTRY1_USERNAME="${{ secrets.IRON_BANK_ROBOT_USERNAME }}" \ 57 | --set REGISTRY1_PASSWORD="${{ secrets.IRON_BANK_ROBOT_PASSWORD }}" \ 58 | --set GH_TOKEN="${{ secrets.GITHUB_TOKEN }}" \ 59 | --set CHAINGUARD_IDENTITY="${{ secrets.CHAINGUARD_IDENTITY }}" 60 | shell: bash 61 | 62 | - name: Publish Packages/Bundles 63 | run: uds run publish-release --set BUNDLE_PATH=bundles/${{ matrix.bundle }} --no-progress 64 | 65 | - name: Save logs 66 | if: ${{ always() }} 67 | run: uds run actions:save-logs 68 | shell: bash 69 | 70 | - uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 71 | if: ${{ always() }} 72 | with: 73 | name: debug-log-${{ matrix.bundle }}-${{ github.run_id }}-${{ github.run_attempt }}-${{ runner.arch }} 74 | path: | 75 | /tmp/zarf-*.log 76 | /tmp/uds-*.log 77 | /tmp/maru-*.log 78 | /tmp/debug-*.log 79 | /tmp/uds-containerd-logs 80 | /tmp/k3d-uds-*.log 81 | -------------------------------------------------------------------------------- /tasks.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | includes: 5 | - test: ./tasks/test.yaml 6 | - create-bundle: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/create.yaml 7 | - deploy-bundle: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/deploy.yaml 8 | - publish-bundle: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/publish.yaml 9 | - pull-bundle: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/pull.yaml 10 | - setup-bundle: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/setup.yaml 11 | - lint: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/lint.yaml 12 | - actions: https://raw.githubusercontent.com/defenseunicorns/uds-common/v1.8.0/tasks/actions.yaml 13 | 14 | variables: 15 | - name: BUNDLE_PATH 16 | default: bundles/dev 17 | 18 | tasks: 19 | - name: default 20 | description: Build and deploy SWF on UDS k3d-slim-dev 21 | actions: 22 | - task: setup-bundle:k3d-test-cluster 23 | - task: create-deploy-test-bundle 24 | 25 | - name: create-deploy-test-bundle 26 | description: Test and validate cluster is deployed with the SWF Bundle 27 | actions: 28 | - task: create-bundle:test-bundle 29 | with: 30 | path: ${BUNDLE_PATH} 31 | config: ${BUNDLE_PATH}/uds-config.yaml 32 | - task: deploy-bundle:test-bundle 33 | with: 34 | path: ${BUNDLE_PATH} 35 | config: ${BUNDLE_PATH}/uds-config.yaml 36 | - task: setup-bundle:create-doug-user 37 | - task: test:all 38 | 39 | # CI will execute the following (via uds-common/.github/actions/test) so they need to be here with these names 40 | 41 | - name: test-install 42 | description: Test the SWF bundle from the current branch 43 | actions: 44 | - task: setup-bundle:k3d-test-cluster 45 | - task: create-deploy-test-bundle 46 | 47 | - name: test-upgrade 48 | description: Test an upgrade from the latest released bundle to the current branch 49 | actions: 50 | - task: pull-bundle:latest-bundle-release 51 | with: 52 | spoof_release: "true" 53 | path: ${BUNDLE_PATH} 54 | - task: setup-bundle:k3d-test-cluster 55 | - task: deploy-bundle:test-bundle 56 | with: 57 | path: ${BUNDLE_PATH} 58 | config: ${BUNDLE_PATH}/uds-config.yaml 59 | - task: create-deploy-test-bundle 60 | 61 | - name: publish-release 62 | description: Build and publish the bundles 63 | actions: 64 | - task: actions:determine-arch 65 | - task: setup-bundle:k3d-test-cluster 66 | if: ${{ ne .variables.ARCH "arm64" }} 67 | - task: create-deploy-test-bundle 68 | if: ${{ ne .variables.ARCH "arm64" }} 69 | - task: create-bundle:test-bundle 70 | with: 71 | path: ${BUNDLE_PATH} 72 | config: ${BUNDLE_PATH}/uds-config.yaml 73 | if: ${{ eq .variables.ARCH "arm64" }} 74 | - description: Publish the bundle 75 | - task: publish-bundle:test-bundle 76 | with: 77 | path: ${BUNDLE_PATH} 78 | # x-release-please-start-version 79 | version: "0.4.2" 80 | # x-release-please-end 81 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | name: Test 5 | 6 | on: 7 | # This workflow is triggered on pull requests to the main branch. 8 | pull_request: 9 | # milestoned is added here as a workaround for release-please not triggering PR workflows (PRs should be added to a milestone to trigger the workflow). 10 | types: [milestoned, opened, reopened, synchronize] 11 | paths-ignore: 12 | - "**.md" 13 | - "**.jpg" 14 | - "**.png" 15 | - "**.gif" 16 | - "**.svg" 17 | - adr/** 18 | - docs/** 19 | - .gitignore 20 | - renovate.json 21 | - .release-please-config.json 22 | - release-please-config.json 23 | - CODEOWNERS 24 | - LICENSE 25 | - CONTRIBUTING.md 26 | - SECURITY.md 27 | 28 | # Permissions for the GITHUB_TOKEN used by the workflow. 29 | permissions: 30 | contents: read # Allows reading the content of the repository. 31 | packages: read # Allows reading the content of the repository's packages. 32 | id-token: write 33 | 34 | # Abort prior jobs in the same workflow / PR 35 | concurrency: 36 | group: test-${{ github.ref }} 37 | cancel-in-progress: true 38 | 39 | jobs: 40 | run: 41 | runs-on: uds-swf-ubuntu-big-boy-16-core 42 | timeout-minutes: 40 43 | strategy: 44 | fail-fast: true 45 | matrix: 46 | bundle: [k3d-demo, dev] 47 | type: [install, upgrade] 48 | 49 | steps: 50 | - name: Checkout repository 51 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 52 | with: 53 | fetch-depth: 0 54 | 55 | - name: Install UDS CLI 56 | uses: defenseunicorns/setup-uds@ab842abcad1f7a3305c2538e3dd1950d0daacfa5 # v1.0.1 57 | with: 58 | # renovate: datasource=github-tags depName=defenseunicorns/uds-cli versioning=semver 59 | version: v0.21.0 60 | 61 | - name: Environment setup 62 | run: | 63 | uds run actions:setup-environment \ 64 | --set REGISTRY1_USERNAME="${{ secrets.IRON_BANK_ROBOT_USERNAME }}" \ 65 | --set REGISTRY1_PASSWORD="${{ secrets.IRON_BANK_ROBOT_PASSWORD }}" \ 66 | --set GH_TOKEN="${{ secrets.GITHUB_TOKEN }}" \ 67 | --set CHAINGUARD_IDENTITY="${{ secrets.CHAINGUARD_IDENTITY }}" 68 | shell: bash 69 | 70 | - name: Test 71 | run: uds run actions:test-deploy --set TYPE="${{ matrix.type }}" --set BUNDLE_PATH="bundles/${{ matrix.bundle }}" 72 | shell: bash 73 | 74 | - name: Debug Output 75 | if: ${{ always() }} 76 | run: uds run actions:debug-output 77 | shell: bash 78 | 79 | - name: Save logs 80 | if: ${{ always() }} 81 | run: uds run actions:save-logs 82 | shell: bash 83 | 84 | - uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 85 | if: ${{ always() }} 86 | with: 87 | name: debug-log-${{ matrix.type }}-${{ matrix.bundle }}-${{ github.run_id }}-${{ github.run_attempt }}-${{ runner.arch }} 88 | path: | 89 | /tmp/zarf-*.log 90 | /tmp/uds-*.log 91 | /tmp/maru-*.log 92 | /tmp/debug-*.log 93 | /tmp/uds-containerd-logs 94 | /tmp/k3d-uds-*.log 95 | -------------------------------------------------------------------------------- /docs/database.md: -------------------------------------------------------------------------------- 1 | # Database 2 | 3 | Software Factory applications that require a database are configured to use Postgresql as a backend. This service can be provided to a given application in a few supported ways: 4 | 5 | ## UDS Postgres Operator Package 6 | 7 | If your environment requires an in-cluster solution, you can make use of the [UDS Postgres Operator Package](https://github.com/defenseunicorns/uds-package-postgres-operator). This can be included in your `uds-bundle.yaml` and is configured through the `postgresql` Helm value to create the required CRs for the operator. Below is an example of what this configuration would look like for an application (GitLab in this case): 8 | 9 | ```yaml 10 | postgresql: 11 | enabled: true 12 | teamId: "uds" 13 | volume: 14 | size: "10Gi" 15 | numberOfInstances: 2 16 | users: 17 | gitlab.gitlab: [] 18 | databases: 19 | gitlabdb: gitlab.gitlab 20 | version: "13" 21 | ingress: 22 | - remoteGenerated: Anywhere 23 | ``` 24 | 25 | Within your bundle you are free to make this a `value` or a `variable` override of the `uds-postgres-config` chart within the `postgres-operator` component as desired. 26 | 27 | > [!IMPORTANT] 28 | > The above configuration sets the `gitlabdb` to be owned by the `gitlab.gitlab` user which will translate to `{namespace}.{username}` to create a secret that shares the name of the username within the specified namespace. You can learn more about configuring the databases and operator within the [Postgres Operator docs](https://github.com/zalando/postgres-operator/tree/master/docs). 29 | 30 | To configure this database within an application you usually will need the secret reference, the username, and the database endpoint. For the above those would be: 31 | 32 | - Username: `gitlab.gitlab` 33 | - Secret Reference: `gitlab.gitlab.pg-cluster.credentials.postgresql.acid.zalan.do` 34 | - Database Endpoint: `pg-cluster.postgres.svc.cluster.local` 35 | 36 | > [!TIP] 37 | > You can find a practical example of how this is configured within a bundle inside of the `bundles/k3d-demo` bundle where the [Postgres Operator is included](https://github.com/defenseunicorns/uds-software-factory/blob/5c7f9fea76ec074a17555109fc55f733e3d27747/bundles/k3d-demo/uds-bundle.yaml#L39) and where it is [configured to work with applications](https://github.com/defenseunicorns/uds-software-factory/blob/5c7f9fea76ec074a17555109fc55f733e3d27747/bundles/k3d-demo/uds-bundle.yaml#L180). 38 | 39 | ## External Database Provider (Username/Password) 40 | 41 | In order to connect to a database with a username and password you first need to wire up the `postgres.password` key in the UDS config chart to create the required secret reference. Then, depending on your application, will need to wire in the `username`, `endpoint` and any other connection information as the application requires. This is a similar process to the configuration for the Postgres Operator above just providing the values needed for your database service. 42 | 43 | ## AWS IAM Roles for Service Accounts (IRSA) 44 | 45 | Software Factory Packages also support IAM Roles for Service Accounts to connect to the Relational Database Service (RDS). This is done by enabling IRSA on your cluster and creating IAM Roles for Kubernetes Service Accounts to assume. You can see a guide for how to [setup IRSA on EKS within the AWS documentation](https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/setting-up-enable-IAM.html). 46 | 47 | Wiring this into an application is app specific (and will be documented in that app's `configuration.md` file) but generally involves instructing the app to use IAM roles and then annotating the Service Accounts with the correct Amazon Resource Name (ARN) corresponding to the role you want it to assume. 48 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Welcome to UDS Software Factory 2 | 3 | Thank you for your interest in UDS Software Factory! 4 | 5 | This document describes the process and requirements for contributing. 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 | ### Developer Workflow 20 | 21 | :key: == Required by automation 22 | 23 | 1. Drop a comment in any issue to let everyone know you're working on it and submit a Draft PR (step 4) as soon as you are able. 24 | 2. :key: Set up your Git config to GPG sign all commits. [Here's some documentation on how to set it up](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). You won't be able to merge your PR if you have any unverified commits. 25 | 3. Create a Draft Pull Request as soon as you can, even if it is just 5 minutes after you started working on it. We lean towards working in the open as much as we can. 26 | > ⚠️ **NOTE:** _:key: We use [Conventional Commit messages](https://www.conventionalcommits.org/) in PR titles so, if you can, use one of `fix:`, `feat:`, `chore:`, `docs:` or similar. If you need help, just use with `wip:` and we'll help with the rest_ 27 | 4. :key: Automated tests will begin based on the paths you have edited in your Pull Request. 28 | > ⚠️ **NOTE:** _If you are an external third-party contributor, the pipelines won't run until a [CODEOWNER](./CODEOWNERS) approves the pipeline run._ 29 | 5. :key: Be sure to heed the `needs-adr`,`needs-docs`,`needs-tests` labels as appropriate for the PR. Once you have addressed all of the needs, remove the label or request a maintainer to remove it. 30 | 6. Once the review is complete and approved, a core member of the project will merge your PR. If you are an external third-party contributor, two core members of the project will be required to approve the PR. 31 | 7. Close the issue if it is fully resolved by your PR. _Hint: You can add "Fixes #XX" to the PR description to automatically close an issue when the PR is merged._ 32 | 33 | ### Architecture Decision Records (ADR) 34 | 35 | We've chosen to use ADRs to document architecturally significant decisions. We primarily use the guidance found in [this article by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) with a couple of tweaks: 36 | 37 | - The criteria for when an ADR is needed is undefined. The team will decide when the team needs an ADR. 38 | - We will use the tool [adr-tools](https://github.com/npryce/adr-tools) to make it easier on us to create and maintain ADRs. 39 | - We will keep ADRs specific to this package in the repository under `adr/NNNN-name-of-adr.md`. 40 | > `adr-tools` is configured with a dotfile to automatically use this directory and format. 41 | - We will keep ADRs relating to Software Factory as a whole in the [UDS Software Factory](https://github.com/defenseunicorns/uds-software-factory) repository under `adr/NNNN-name-of-adr.md`. 42 | 43 | ### How to use `adr-tools` 44 | 45 | ```bash 46 | # Create a new ADR titled "Use Bisquick for all waffle making" 47 | adr new Use Bisquick for all waffle making 48 | 49 | # Create a new ADR that supersedes a previous one. Let's say, for example, that the previous ADR about Bisquick was ADR number 9. 50 | adr new -s 9 Use scratch ingredients for all waffle making 51 | 52 | # Create a new ADR that amends a previous one. Let's say the previous one was ADR number 15 53 | adr new -l "15:Amends:Amended by" Use store-bought butter for all waffle making 54 | 55 | # Get full help docs. There are all sorts of other helpful commands that help manage the decision log. 56 | adr help 57 | ``` 58 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🏭 UDS Software Factory 2 | 3 | [Made for UDS](https://github.com/defenseunicorns/uds-core) 4 | [![Latest Release](https://img.shields.io/github/v/release/defenseunicorns/uds-software-factory)](https://github.com/defenseunicorns/uds-software-factory/releases) 5 | [![Build Status](https://img.shields.io/github/actions/workflow/status/defenseunicorns/uds-software-factory/release.yaml)](https://github.com/defenseunicorns/uds-software-factory/release.yaml) 6 | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/defenseunicorns/uds-software-factory/badge)](https://api.securityscorecards.dev/projects/github.com/defenseunicorns/uds-software-factory) 7 | 8 | This is the integration / wayfinding repository for the UDS Software Factory created and offered by Defense Unicorns. The Software Factory is made up of bundled applications that assist with development of new software in airgap environments. These applications are split into `primary` and `lab` applications to denote applications that are ready for wider use and those that we are still learning from and experimenting with. 9 | 10 | The `primary` UDS Software Factory packages are: 11 | 12 | - [GitLab](https://github.com/defenseunicorns/uds-package-gitlab) - a DevOps software package that can develop, secure, and operate software 13 | - [GitLab Runner](https://github.com/defenseunicorns/uds-package-gitlab-runner) - a Continuous Integration runner that integrates with GitLab 14 | - [Renovate](https://github.com/defenseunicorns/uds-package-renovate) - a dependency checking bot that integrates with GitLab 15 | - [Mattermost](https://github.com/defenseunicorns/uds-package-mattermost) - an open-source, self-hostable online chat service 16 | - [SonarQube](https://github.com/defenseunicorns/uds-package-sonarqube) - an open-source platform developed by SonarSource for continuous inspection of code quality 17 | - [Postgres Operator](https://github.com/defenseunicorns/uds-package-postgres-operator) - a Kubernetes operator to deploy PostgreSQL databases in a cluster 18 | - [Valkey](https://github.com/defenseunicorns/uds-package-valkey) - a Redis-alternative that can be deployed in a cluster (intended for use with GitLab) 19 | 20 | The `lab` UDS Software Factory packages are: 21 | 22 | - [Sigstore](https://github.com/defenseunicorns/uds-package-sigstore) - a keyless signing infrastructure for software artifact signing and attestations 23 | - [Archivista](https://github.com/defenseunicorns/uds-package-archivista) - a GraphQL datastore for in-toto attestations 24 | 25 | This repo serves as an integration repository for testing, creating common [Architectural Decision Records](./adr), and tracking issues that have effects across the individual packages that make up Software Factory. 26 | 27 | Also note that the Software Factory team helps to manage the following UDS packages and repositories: 28 | 29 | - [UDS Common](https://github.com/defenseunicorns/uds-common) - a common repo to share workflows, UDS tasks and more between UDS Package repositories 30 | - ⚠️ (alpha) [Minio Operator](https://github.com/defenseunicorns/uds-package-minio-operator) - an S3-compatible object storage provider 31 | 32 | ### 📜 tl;dr - [try it now](#quickstart-demo-bundle) 33 | 34 | ## Bundles 35 | 36 | > [!CAUTION] 37 | > These UDS Bundles are intended for dev, test and demo environments and should _not_ be used for production. They can however serve as examples to create custom bundles. 38 | 39 | This repository publishes multiple bundles for dev, test and demo purposes. They are located in sub-directories under `bundles`. 40 | 41 | ### swf-dev 42 | 43 | This bundle is for development of the `primary` Software Factory packages and is located at `bundles/dev`. It requires an existing Kubernetes cluster with at least [UDS Core Base](https://github.com/defenseunicorns/uds-core/tree/main/packages/base) and [UDS Core Identity and Authorization](https://github.com/defenseunicorns/uds-core/tree/main/packages/identity-authorization) on it to deploy. 44 | 45 | This bundle requires ~ `9 CPUs and 28GB of memory` available to run. 46 | 47 | ### k3d-swf-demo 48 | 49 | This bundle is a demo bundle of the `primary` Software Factory packages deployed on top of full [UDS Core](https://github.com/defenseunicorns/uds-core). It includes the deployment of an underlying K3d cluster and is located at `bundles/k3d-demo` 50 | 51 | This is a fairly large bundle and requires `16 CPUs and 64GB of memory` available to run. It is best deployed on an adequately sized Linux machine with Docker or equivalent installed. This is not currently tested on macOS due to resource limitations. 52 | 53 | --- 54 | 55 | ### Quickstart (Demo Bundle) 56 | 57 | If you have the resources for it locally (see above), you can deploy the `primary` Software Factory packages with full `uds-core` and `k3d` using the [uds-k3d-swf-demo bundle](./bundles/k3d-demo/README.md). 58 | 59 | #### Prerequisites 60 | 61 | - [Docker Compatible Runtime](https://docs.docker.com/engine/) necessary for running `k3d`. 62 | - [UDS CLI](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install) v0.10.4 or later 63 | 64 | > [!NOTE] 65 | > Apple users follow these [instructions](./docs/development.md) to properly set up your environment to deploy this bundle. 66 | 67 | #### Deployment 68 | 69 | To deploy this bundle run the following command: 70 | 71 | 72 | 73 | ```bash 74 | uds deploy k3d-swf-demo:0.4.2 75 | ``` 76 | 77 | 78 | 79 | ### Quickstart (Dev Bundle) 80 | 81 | Alternatively, you can deploy the [uds-swf-dev bundle](./bundles/dev/README.md), which is meant to be deployed on top of [k3d-core-slim-dev](https://github.com/defenseunicorns/uds-core/blob/main/bundles/k3d-slim-dev/README.md) or another Kubernetes cluster with at least [UDS Core Base](https://github.com/defenseunicorns/uds-core/tree/main/packages/base) and [UDS Core Identity and Authorization](https://github.com/defenseunicorns/uds-core/tree/main/packages/identity-authorization). This bundle includes the `primary` Software Factory packages, but only requires part of the underlying `uds-core` baseline allowing it to be run on a wider variety of hardware, particularly with local development in mind. 82 | 83 | #### Prerequisites 84 | 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-esque environments. 86 | - [UDS CLI](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install) v0.10.4 or later 87 | 88 | > [!NOTE] 89 | > Apple users follow these [instructions](./docs/development.md) to properly set up your environment to deploy this bundle. 90 | 91 | #### Deployment 92 | 93 | For `swf-dev` you have two options, build and deploy from source or deploy the artifacts from where they are hosted in the `ghcr.io` OCI registry. 94 | 95 | ##### 1. Deploy from Source 96 | 97 | To build and deploy from source you can utilize the UDS tasks in this repo by running: 98 | 99 | ```bash 100 | uds run 101 | ``` 102 | 103 | ##### 2. Deploy from Artifacts 104 | 105 | _Alternatively_, you can deploy from OCI by running the following two commands: 106 | 107 | To easily create a K3d cluster with [UDS Core Base](https://github.com/defenseunicorns/uds-core/tree/main/packages/base) and [UDS Core Identity and Authorization](https://github.com/defenseunicorns/uds-core/tree/main/packages/identity-authorization) run the below command to deploy the `k3d-core-slim-dev` bundle: 108 | 109 | > [!TIP] 110 | > You can append `--set INSECURE_ADMIN_PASSWORD_GENERATION=true` to the below command to enable a default keycloak admin. This is useful for development and testing of the SWF stack and enables the ability to run `uds run setup:create-doug-user` to create a user to test with using the username `doug` and the password `unicorn123!@#UN`. 111 | 112 | > [!TIP] 113 | > You can install this bundle on nearly any Kubernetes cluster as long as you install the Base and Identity and Authorization layers from UDS Core. You may need to make some changes to your node configuration which you can see in the [development documentation](./docs/development.md#linux-users). 114 | 115 | ```bash 116 | uds deploy k3d-core-slim-dev:0.35.0 117 | ``` 118 | 119 | Run the below command to deploy the `swf-dev` bundle on top of the dev cluster: 120 | 121 | 122 | ```bash 123 | uds deploy swf-dev:0.4.2 124 | ``` 125 | 126 | 127 | ## Development 128 | 129 | When developing these bundles it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/uds-packages/development/development-ide-configuration.md) in uds-common. 130 | -------------------------------------------------------------------------------- /bundles/dev/uds-bundle.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | kind: UDSBundle 5 | metadata: 6 | name: swf-dev 7 | description: A UDS bundle for deploying the UDS Software Factory on a development cluster 8 | # x-release-please-start-version 9 | version: 0.4.2 10 | # x-release-please-end 11 | 12 | packages: 13 | 14 | - name: minio-operator 15 | repository: ghcr.io/defenseunicorns/packages/uds/minio-operator 16 | ref: 7.0.0-uds.1-upstream 17 | overrides: 18 | minio-operator: 19 | uds-minio-config: 20 | values: 21 | # Test helm overrides to provision app specific buckets, policies and creds 22 | - path: apps 23 | value: 24 | - name: gitlab 25 | namespace: gitlab 26 | bucketNames: 27 | - uds-gitlab-artifacts 28 | - uds-gitlab-backups 29 | - uds-gitlab-ci-secure-files 30 | - uds-gitlab-dependency-proxy 31 | - uds-gitlab-lfs 32 | - uds-gitlab-mr-diffs 33 | - uds-gitlab-packages 34 | - uds-gitlab-pages 35 | - uds-gitlab-terraform-state 36 | - uds-gitlab-uploads 37 | - uds-gitlab-registry 38 | - uds-gitlab-tmp 39 | policy: "" 40 | copyPassword: 41 | enabled: true 42 | secretName: "gitlab-minio" 43 | secretIDKey: "access_key" 44 | secretPasswordKey: "secret_key" 45 | - name: mattermost 46 | namespace: mattermost 47 | bucketNames: 48 | - uds-mattermost-dev 49 | policy: "" 50 | copyPassword: 51 | enabled: true 52 | secretName: "mattermost-minio" 53 | secretIDKey: "access_key" 54 | secretPasswordKey: "secret_key" 55 | 56 | 57 | - name: postgres-operator 58 | repository: ghcr.io/defenseunicorns/packages/uds/postgres-operator 59 | ref: 1.14.0-uds.0-upstream 60 | overrides: 61 | postgres-operator: 62 | uds-postgres-config: 63 | variables: 64 | - name: POSTGRESQL 65 | description: "Configure postgres using CRs via the uds-postgres-config chart" 66 | path: postgresql 67 | default: 68 | enabled: true 69 | teamId: "uds" 70 | volume: 71 | size: "10Gi" 72 | numberOfInstances: 2 73 | users: 74 | gitlab.gitlab: [] 75 | sonarqube.sonarqube: [] 76 | mattermost.mattermost: [] 77 | databases: 78 | gitlabdb: gitlab.gitlab 79 | sonarqubedb: sonarqube.sonarqube 80 | mattermost: mattermost.mattermost 81 | version: "14" 82 | ingress: 83 | - remoteNamespace: gitlab 84 | - remoteNamespace: sonarqube 85 | - remoteNamespace: mattermost 86 | 87 | - name: valkey 88 | repository: ghcr.io/defenseunicorns/packages/uds/valkey 89 | ref: 8.0.2-uds.0-upstream 90 | overrides: 91 | valkey: 92 | uds-valkey-config: 93 | values: 94 | - path: custom 95 | value: 96 | - direction: Ingress 97 | selector: 98 | app.kubernetes.io/name: valkey 99 | remoteNamespace: gitlab 100 | port: 6379 101 | description: "Ingress from GitLab" 102 | - path: copyPassword 103 | value: 104 | enabled: true 105 | namespace: gitlab 106 | secretName: gitlab-redis 107 | secretKey: password 108 | valkey: 109 | variables: 110 | - name: VALKEY_RESOURCES 111 | path: "master.resources" 112 | default: 113 | limits: 114 | cpu: 100m 115 | memory: 300Mi 116 | requests: 117 | cpu: 100m 118 | memory: 300Mi 119 | 120 | - name: gitlab 121 | repository: ghcr.io/defenseunicorns/packages/uds/gitlab 122 | ref: 17.8.1-uds.0-upstream 123 | overrides: 124 | gitlab: 125 | uds-gitlab-config: 126 | variables: 127 | - name: GITLAB_SSO_ENABLED 128 | description: "Boolean to enable or disable sso things" 129 | path: "sso.enabled" 130 | gitlab: 131 | values: 132 | - path: global.psql.host 133 | value: pg-cluster.postgres.svc.cluster.local 134 | - path: "global.psql.username" 135 | value: "gitlab.gitlab" 136 | - path: "global.psql.password.secret" 137 | value: "gitlab.gitlab.pg-cluster.credentials.postgresql.acid.zalan.do" 138 | - path: global.redis.host 139 | value: valkey-master.valkey.svc.cluster.local 140 | variables: 141 | - name: GITLAB_SSO_ENABLED 142 | description: "Boolean to enable or disable sso things" 143 | path: "global.appConfig.omniauth.enabled" 144 | - name: GITLAB_PAGES_ENABLED 145 | description: "Boolean to enable or disable sso things" 146 | path: "global.pages.enabled" 147 | default: true 148 | - name: DISABLE_REGISTRY_REDIRECT 149 | description: "Gitlab Registry Disable Redirect" 150 | path: "registry.storage.redirect.disable" 151 | default: true 152 | - name: MIGRATIONS_RESOURCES 153 | description: "Gitlab Migrations Resources" 154 | path: "gitlab.migrations.resources" 155 | default: 156 | limits: 157 | cpu: 500m 158 | memory: 4G 159 | - name: WEBSERVICE_REPLICAS 160 | description: "Gitlab Webservice Min Replicas" 161 | path: "gitlab.webservice.minReplicas" 162 | default: 1 163 | - name: WEBSERVICE_RESOURCES 164 | description: "Gitlab Webservice Resources" 165 | path: "gitlab.webservice.resources" 166 | default: 167 | limits: 168 | memory: 3.5G 169 | requests: 170 | cpu: 300m 171 | memory: 2.5G 172 | - name: WORKHORSE_RESOURCES 173 | description: "Gitlab Workhorse Resources" 174 | path: "gitlab.webservice.workhorse.resources" 175 | default: 176 | limits: 177 | memory: 100M 178 | requests: 179 | cpu: 10m 180 | memory: 10M 181 | - name: TOOLBOX_RESOURCES 182 | description: "Gitlab Toolbox Resources" 183 | path: "gitlab.toolbox.resources" 184 | default: 185 | limits: 186 | cpu: 2000m 187 | memory: 3584M 188 | requests: 189 | cpu: 500m 190 | memory: 1000M 191 | - name: SIDEKIQ_REPLICAS 192 | description: "Gitlab Sidekiq Min Replicas" 193 | path: "gitlab.sidekiq.minReplicas" 194 | default: 1 195 | - name: SIDEKIQ_RESOURCES 196 | description: "Gitlab Sidekiq Resources" 197 | path: "gitlab.sidekiq.resources" 198 | default: 199 | limits: 200 | memory: 1.5G 201 | requests: 202 | cpu: 50m 203 | memory: 625M 204 | - name: PAGES_RESOURCES 205 | description: "GitLab Pages Resources" 206 | path: "gitlab.gitlab-pages.resources" 207 | default: 208 | limits: 209 | memory: 1.5G 210 | requests: 211 | cpu: 50m 212 | memory: 625M 213 | - name: REGISTRY_REPLICAS 214 | description: "Gitlab Registry Min Replicas" 215 | path: "registry.hpa.minReplicas" 216 | default: 1 217 | - name: SHELL_REPLICAS 218 | description: "Gitlab Shell Min Replicas" 219 | path: "gitlab.gitlab-shell.minReplicas" 220 | default: 1 221 | uds-gitlab-settings: 222 | values: 223 | - path: "botAccounts" 224 | value: 225 | enabled: true 226 | accounts: 227 | - username: renovatebot 228 | scopes: 229 | - api 230 | - read_repository 231 | - write_repository 232 | secret: 233 | name: gitlab-renovatebot 234 | namespace: renovate 235 | keyName: TOKEN 236 | 237 | - name: gitlab-runner 238 | repository: ghcr.io/defenseunicorns/packages/uds/gitlab-runner 239 | ref: 17.8.3-uds.0-upstream 240 | 241 | - name: valkey 242 | repository: ghcr.io/defenseunicorns/packages/uds/valkey 243 | ref: 8.0.2-uds.0-upstream 244 | overrides: 245 | valkey: 246 | valkey: 247 | # use a custom namespace here in the test bundle 248 | # to deconflict with valkey deployed by gitlab dependency 249 | namespace: "valkey-renovate" 250 | uds-valkey-config: 251 | namespace: "valkey-renovate" 252 | values: 253 | - path: custom 254 | value: 255 | - direction: Ingress 256 | selector: 257 | app.kubernetes.io/name: valkey 258 | remoteNamespace: renovate 259 | port: 6379 260 | description: "Ingress from Renovate" 261 | - path: copyPassword 262 | value: 263 | enabled: true 264 | namespace: renovate 265 | secretName: valkey-password 266 | secretKey: password 267 | 268 | - name: renovate 269 | repository: ghcr.io/defenseunicorns/packages/uds/renovate 270 | ref: 39.140.2-uds.0-upstream 271 | 272 | - name: sonarqube 273 | repository: ghcr.io/defenseunicorns/packages/uds/sonarqube 274 | ref: 25.1.0.102122-uds.0-upstream 275 | overrides: 276 | sonarqube: 277 | sonarqube: 278 | values: 279 | - path: "jdbcOverwrite.jdbcSecretName" 280 | value: "sonarqube.sonarqube.pg-cluster.credentials.postgresql.acid.zalan.do" 281 | - path: "jdbcOverwrite.jdbcUsername" 282 | value: "sonarqube.sonarqube" 283 | - path: "jdbcOverwrite.jdbcUrl" 284 | value: "jdbc:postgresql://pg-cluster.postgres.svc.cluster.local:5432/sonarqubedb" 285 | variables: 286 | - name: SONARQUBE_RESOURCES 287 | path: "resources" 288 | default: 289 | limits: 290 | cpu: 800m 291 | memory: 6144M 292 | requests: 293 | cpu: 400m 294 | memory: 2048M 295 | 296 | - name: mattermost 297 | repository: ghcr.io/defenseunicorns/packages/uds/mattermost 298 | ref: 10.4.2-uds.0-upstream 299 | overrides: 300 | mattermost: 301 | uds-mattermost-config: 302 | values: 303 | - path: "objectStorage.secure" 304 | value: "false" 305 | - path: "objectStorage.endpoint" 306 | value: "uds-minio-hl.minio.svc.cluster.local:9000" 307 | - path: "objectStorage.bucket" 308 | value: "uds-mattermost-dev" 309 | - path: "postgres.host" 310 | value: "pg-cluster.postgres.svc.cluster.local" 311 | - path: "postgres.connectionOptions" 312 | value: "?connect_timeout=10" 313 | - path: "postgres.username" 314 | value: "mattermost.mattermost" 315 | variables: 316 | - name: MATTERMOST_RESOURCES 317 | path: "resources" 318 | default: 319 | limits: 320 | cpu: 100m 321 | memory: 300Mi 322 | requests: 323 | cpu: 100m 324 | memory: 300Mi 325 | -------------------------------------------------------------------------------- /bundles/k3d-demo/uds-bundle.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2024 Defense Unicorns 2 | # SPDX-License-Identifier: AGPL-3.0-or-later OR LicenseRef-Defense-Unicorns-Commercial 3 | 4 | kind: UDSBundle 5 | metadata: 6 | name: k3d-swf-demo 7 | description: A UDS bundle for deploying the UDS Software Factory with full uds-core on a development cluster 8 | # x-release-please-start-version 9 | version: 0.4.2 10 | # x-release-please-end 11 | 12 | packages: 13 | - name: uds-k3d-dev 14 | repository: ghcr.io/defenseunicorns/packages/uds-k3d 15 | ref: 0.12.0 16 | 17 | - name: init 18 | repository: ghcr.io/defenseunicorns/packages/init 19 | ref: v0.36.1 20 | 21 | - name: uds-core 22 | repository: ghcr.io/defenseunicorns/packages/uds/core 23 | ref: "0.35.0-upstream" 24 | optionalComponents: 25 | - metrics-server 26 | overrides: 27 | keycloak: 28 | keycloak: 29 | variables: 30 | - name: INSECURE_ADMIN_PASSWORD_GENERATION 31 | description: "Generate an insecure admin password for dev/test" 32 | path: insecureAdminPasswordGeneration.enabled 33 | default: true 34 | 35 | - name: minio-operator 36 | repository: ghcr.io/defenseunicorns/packages/uds/minio-operator 37 | ref: 7.0.0-uds.1-upstream 38 | overrides: 39 | minio-operator: 40 | uds-minio-config: 41 | values: 42 | # Test helm overrides to provision app specific buckets, policies and creds 43 | - path: apps 44 | value: 45 | - name: gitlab 46 | namespace: gitlab 47 | bucketNames: 48 | - uds-gitlab-artifacts 49 | - uds-gitlab-backups 50 | - uds-gitlab-ci-secure-files 51 | - uds-gitlab-dependency-proxy 52 | - uds-gitlab-lfs 53 | - uds-gitlab-mr-diffs 54 | - uds-gitlab-packages 55 | - uds-gitlab-pages 56 | - uds-gitlab-terraform-state 57 | - uds-gitlab-uploads 58 | - uds-gitlab-registry 59 | - uds-gitlab-tmp 60 | policy: "" 61 | copyPassword: 62 | enabled: true 63 | secretName: "gitlab-minio" 64 | secretIDKey: "access_key" 65 | secretPasswordKey: "secret_key" 66 | - name: mattermost 67 | namespace: mattermost 68 | bucketNames: 69 | - uds-mattermost-dev 70 | policy: "" 71 | copyPassword: 72 | enabled: true 73 | secretName: "mattermost-minio" 74 | secretIDKey: "access_key" 75 | secretPasswordKey: "secret_key" 76 | 77 | - name: postgres-operator 78 | repository: ghcr.io/defenseunicorns/packages/uds/postgres-operator 79 | ref: 1.14.0-uds.0-upstream 80 | overrides: 81 | postgres-operator: 82 | uds-postgres-config: 83 | variables: 84 | - name: POSTGRESQL 85 | description: "Configure postgres using CRs via the uds-postgres-config chart" 86 | path: postgresql 87 | default: 88 | enabled: true 89 | teamId: "uds" 90 | volume: 91 | size: "10Gi" 92 | numberOfInstances: 2 93 | users: 94 | gitlab.gitlab: [] 95 | sonarqube.sonarqube: [] 96 | mattermost.mattermost: [] 97 | databases: 98 | gitlabdb: gitlab.gitlab 99 | sonarqubedb: sonarqube.sonarqube 100 | mattermost: mattermost.mattermost 101 | version: "14" 102 | ingress: 103 | - remoteNamespace: gitlab 104 | - remoteNamespace: sonarqube 105 | - remoteNamespace: mattermost 106 | 107 | - name: valkey 108 | repository: ghcr.io/defenseunicorns/packages/uds/valkey 109 | ref: 8.0.2-uds.0-upstream 110 | overrides: 111 | valkey: 112 | uds-valkey-config: 113 | values: 114 | - path: custom 115 | value: 116 | - direction: Ingress 117 | selector: 118 | app.kubernetes.io/name: valkey 119 | remoteNamespace: gitlab 120 | port: 6379 121 | description: "Ingress from GitLab" 122 | - path: copyPassword 123 | value: 124 | enabled: true 125 | namespace: gitlab 126 | secretName: gitlab-redis 127 | secretKey: password 128 | valkey: 129 | variables: 130 | - name: VALKEY_RESOURCES 131 | path: "master.resources" 132 | default: 133 | limits: 134 | cpu: 100m 135 | memory: 300Mi 136 | requests: 137 | cpu: 100m 138 | memory: 300Mi 139 | 140 | - name: gitlab 141 | repository: ghcr.io/defenseunicorns/packages/uds/gitlab 142 | ref: 17.8.1-uds.0-upstream 143 | overrides: 144 | gitlab: 145 | uds-gitlab-config: 146 | variables: 147 | - name: GITLAB_SSO_ENABLED 148 | description: "Boolean to enable or disable sso things" 149 | path: "sso.enabled" 150 | gitlab: 151 | values: 152 | - path: global.psql.host 153 | value: pg-cluster.postgres.svc.cluster.local 154 | - path: "global.psql.username" 155 | value: "gitlab.gitlab" 156 | - path: "global.psql.password.secret" 157 | value: "gitlab.gitlab.pg-cluster.credentials.postgresql.acid.zalan.do" 158 | - path: global.redis.host 159 | value: valkey-master.valkey.svc.cluster.local 160 | variables: 161 | - name: GITLAB_SSO_ENABLED 162 | description: "Boolean to enable or disable sso things" 163 | path: "global.appConfig.omniauth.enabled" 164 | - name: GITLAB_PAGES_ENABLED 165 | description: "Boolean to enable or disable sso things" 166 | path: "global.pages.enabled" 167 | default: true 168 | - name: DISABLE_REGISTRY_REDIRECT 169 | description: "Gitlab Registry Disable Redirect" 170 | path: "registry.storage.redirect.disable" 171 | default: true 172 | - name: MIGRATIONS_RESOURCES 173 | description: "Gitlab Migrations Resources" 174 | path: "gitlab.migrations.resources" 175 | default: 176 | limits: 177 | cpu: 500m 178 | memory: 4G 179 | - name: WEBSERVICE_REPLICAS 180 | description: "Gitlab Webservice Min Replicas" 181 | path: "gitlab.webservice.minReplicas" 182 | default: 1 183 | - name: WEBSERVICE_RESOURCES 184 | description: "Gitlab Webservice Resources" 185 | path: "gitlab.webservice.resources" 186 | default: 187 | limits: 188 | memory: 3.5G 189 | requests: 190 | cpu: 300m 191 | memory: 2.5G 192 | - name: WORKHORSE_RESOURCES 193 | description: "Gitlab Workhorse Resources" 194 | path: "gitlab.webservice.workhorse.resources" 195 | default: 196 | limits: 197 | memory: 100M 198 | requests: 199 | cpu: 10m 200 | memory: 10M 201 | - name: TOOLBOX_RESOURCES 202 | description: "Gitlab Toolbox Resources" 203 | path: "gitlab.toolbox.resources" 204 | default: 205 | limits: 206 | cpu: 2000m 207 | memory: 3584M 208 | requests: 209 | cpu: 500m 210 | memory: 1000M 211 | - name: SIDEKIQ_REPLICAS 212 | description: "Gitlab Sidekiq Min Replicas" 213 | path: "gitlab.sidekiq.minReplicas" 214 | default: 1 215 | - name: SIDEKIQ_RESOURCES 216 | description: "Gitlab Sidekiq Resources" 217 | path: "gitlab.sidekiq.resources" 218 | default: 219 | limits: 220 | memory: 1.5G 221 | requests: 222 | cpu: 50m 223 | memory: 625M 224 | - name: PAGES_RESOURCES 225 | description: "GitLab Pages Resources" 226 | path: "gitlab.gitlab-pages.resources" 227 | default: 228 | limits: 229 | memory: 1.5G 230 | requests: 231 | cpu: 50m 232 | memory: 625M 233 | - name: REGISTRY_REPLICAS 234 | description: "Gitlab Registry Min Replicas" 235 | path: "registry.hpa.minReplicas" 236 | default: 1 237 | - name: SHELL_REPLICAS 238 | description: "Gitlab Shell Min Replicas" 239 | path: "gitlab.gitlab-shell.minReplicas" 240 | default: 1 241 | uds-gitlab-settings: 242 | values: 243 | - path: "botAccounts" 244 | value: 245 | enabled: true 246 | accounts: 247 | - username: renovatebot 248 | scopes: 249 | - api 250 | - read_repository 251 | - write_repository 252 | secret: 253 | name: gitlab-renovatebot 254 | namespace: renovate 255 | keyName: TOKEN 256 | 257 | - name: gitlab-runner 258 | repository: ghcr.io/defenseunicorns/packages/uds/gitlab-runner 259 | ref: 17.8.3-uds.0-upstream 260 | 261 | - name: valkey 262 | repository: ghcr.io/defenseunicorns/packages/uds/valkey 263 | ref: 8.0.2-uds.0-upstream 264 | overrides: 265 | valkey: 266 | valkey: 267 | # use a custom namespace here in the test bundle 268 | # to deconflict with valkey deployed by gitlab dependency 269 | namespace: "valkey-renovate" 270 | uds-valkey-config: 271 | namespace: "valkey-renovate" 272 | values: 273 | - path: custom 274 | value: 275 | - direction: Ingress 276 | selector: 277 | app.kubernetes.io/name: valkey 278 | remoteNamespace: renovate 279 | port: 6379 280 | description: "Ingress from Renovate" 281 | - path: copyPassword 282 | value: 283 | enabled: true 284 | namespace: renovate 285 | secretName: valkey-password 286 | secretKey: password 287 | 288 | - name: renovate 289 | repository: ghcr.io/defenseunicorns/packages/uds/renovate 290 | ref: 39.140.2-uds.0-upstream 291 | 292 | - name: sonarqube 293 | repository: ghcr.io/defenseunicorns/packages/uds/sonarqube 294 | ref: 25.1.0.102122-uds.0-upstream 295 | overrides: 296 | sonarqube: 297 | sonarqube: 298 | values: 299 | - path: "jdbcOverwrite.jdbcSecretName" 300 | value: "sonarqube.sonarqube.pg-cluster.credentials.postgresql.acid.zalan.do" 301 | - path: "jdbcOverwrite.jdbcUsername" 302 | value: "sonarqube.sonarqube" 303 | - path: "jdbcOverwrite.jdbcUrl" 304 | value: "jdbc:postgresql://pg-cluster.postgres.svc.cluster.local:5432/sonarqubedb" 305 | variables: 306 | - name: SONARQUBE_RESOURCES 307 | path: "resources" 308 | default: 309 | limits: 310 | cpu: 800m 311 | memory: 6144M 312 | requests: 313 | cpu: 400m 314 | memory: 2048M 315 | 316 | - name: mattermost 317 | repository: ghcr.io/defenseunicorns/packages/uds/mattermost 318 | ref: 10.4.2-uds.0-upstream 319 | overrides: 320 | mattermost: 321 | uds-mattermost-config: 322 | values: 323 | - path: "objectStorage.secure" 324 | value: "false" 325 | - path: "objectStorage.endpoint" 326 | value: "uds-minio-hl.minio.svc.cluster.local:9000" 327 | - path: "objectStorage.bucket" 328 | value: "uds-mattermost-dev" 329 | - path: "postgres.host" 330 | value: "pg-cluster.postgres.svc.cluster.local" 331 | - path: "postgres.connectionOptions" 332 | value: "?connect_timeout=10" 333 | - path: "postgres.username" 334 | value: "mattermost.mattermost" 335 | variables: 336 | - name: MATTERMOST_RESOURCES 337 | path: "resources" 338 | default: 339 | limits: 340 | cpu: 100m 341 | memory: 300Mi 342 | requests: 343 | cpu: 100m 344 | memory: 300Mi 345 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## [0.4.2](https://github.com/defenseunicorns/uds-software-factory/compare/v0.4.1...v0.4.2) (2025-02-10) 4 | 5 | 6 | ### Miscellaneous 7 | 8 | * **config:** migrate renovate config ([#138](https://github.com/defenseunicorns/uds-software-factory/issues/138)) ([f74b23e](https://github.com/defenseunicorns/uds-software-factory/commit/f74b23e395299ce05c0bc654e77461d7beacba83)) 9 | * **deps:** update swf bundle dependencies ([#134](https://github.com/defenseunicorns/uds-software-factory/issues/134)) ([863ef55](https://github.com/defenseunicorns/uds-software-factory/commit/863ef55ec2cfbc9c66a280c48c7729793d6a5de9)) 10 | * **deps:** update swf bundle dependencies ([#136](https://github.com/defenseunicorns/uds-software-factory/issues/136)) ([f1c29b6](https://github.com/defenseunicorns/uds-software-factory/commit/f1c29b6423b3963544e87d4b454df9f3be3d5c6b)) 11 | * **deps:** update swf bundle dependencies ([#139](https://github.com/defenseunicorns/uds-software-factory/issues/139)) ([6428fd7](https://github.com/defenseunicorns/uds-software-factory/commit/6428fd751e059943c0ef078130e030f07a7d1a50)) 12 | 13 | ## [0.4.1](https://github.com/defenseunicorns/uds-software-factory/compare/v0.4.0...v0.4.1) (2025-01-08) 14 | 15 | 16 | ### Miscellaneous 17 | 18 | * **deps:** update bundle-deps for mattermost and sonarqube ([#133](https://github.com/defenseunicorns/uds-software-factory/issues/133)) ([a1890f7](https://github.com/defenseunicorns/uds-software-factory/commit/a1890f7d631da0b993bed3050f129762545b748e)) 19 | * **deps:** update swf bundle dependencies ([#127](https://github.com/defenseunicorns/uds-software-factory/issues/127)) ([2aa64af](https://github.com/defenseunicorns/uds-software-factory/commit/2aa64af1e125832ac1a482d1a9a1979f1e4fc361)) 20 | 21 | ## [0.4.0](https://github.com/defenseunicorns/uds-software-factory/compare/v0.3.0...v0.4.0) (2024-12-05) 22 | 23 | 24 | ### Miscellaneous 25 | 26 | * **deps:** update swf bundle dependencies ([#119](https://github.com/defenseunicorns/uds-software-factory/issues/119)) ([ff895ab](https://github.com/defenseunicorns/uds-software-factory/commit/ff895ab562dbcaa41e0bf152aa489977e19ab906)) 27 | 28 | ## [0.3.0](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.7...v0.3.0) (2024-10-25) 29 | 30 | 31 | ### Bug Fixes 32 | 33 | * increase gitlab webservice mem limit to recommended min ([#102](https://github.com/defenseunicorns/uds-software-factory/issues/102)) ([17e1ad4](https://github.com/defenseunicorns/uds-software-factory/commit/17e1ad46e8061a5a135c18155e44315caf90726c)) 34 | * remove uds-runtime from bundle ([#117](https://github.com/defenseunicorns/uds-software-factory/issues/117)) ([563928e](https://github.com/defenseunicorns/uds-software-factory/commit/563928ebc2a05643111b7e512383d61dd049ab27)) 35 | 36 | 37 | ### Miscellaneous 38 | 39 | * badge, add renovate, update READMEs/workflow permissions ([#110](https://github.com/defenseunicorns/uds-software-factory/issues/110)) ([258dbca](https://github.com/defenseunicorns/uds-software-factory/commit/258dbcac1a96268378908f736e3f9c580ebc1216)) 40 | * **deps:** update swf bundle dependencies ([#100](https://github.com/defenseunicorns/uds-software-factory/issues/100)) ([5f6dbc7](https://github.com/defenseunicorns/uds-software-factory/commit/5f6dbc7c4a5fd942e3c73a5019ecbb66f2c82983)) 41 | * **deps:** update swf bundle dependencies ([#103](https://github.com/defenseunicorns/uds-software-factory/issues/103)) ([f2e9b16](https://github.com/defenseunicorns/uds-software-factory/commit/f2e9b166fa99461a9a977c072427b5112a12f73c)) 42 | * **deps:** update swf bundle dependencies ([#109](https://github.com/defenseunicorns/uds-software-factory/issues/109)) ([03b33dc](https://github.com/defenseunicorns/uds-software-factory/commit/03b33dc4bfd730eba8a22e5a0deabce9dcc665a0)) 43 | * **deps:** update swf bundle dependencies ([#115](https://github.com/defenseunicorns/uds-software-factory/issues/115)) ([ac4e1bd](https://github.com/defenseunicorns/uds-software-factory/commit/ac4e1bdab4c877898cadf5918e0e6218961877cf)) 44 | * fix the arm64 publish task ([#113](https://github.com/defenseunicorns/uds-software-factory/issues/113)) ([58a4d7e](https://github.com/defenseunicorns/uds-software-factory/commit/58a4d7ec2449d6ed5a08ea923c611281e1f4486d)) 45 | * set fail-fast to true on test matrix ([#111](https://github.com/defenseunicorns/uds-software-factory/issues/111)) ([13c3b6e](https://github.com/defenseunicorns/uds-software-factory/commit/13c3b6eb892048adfa0ba602d7fc5a56608b56fc)) 46 | 47 | ## [0.2.7](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.6...v0.2.7) (2024-09-20) 48 | 49 | 50 | ### Miscellaneous 51 | 52 | * **deps:** update to `uds-core` v0.27.3, `gitlab` v17.2.7-uds.0 and `gitlab-runner` v17.2.1-uds.1 ([#97](https://github.com/defenseunicorns/uds-software-factory/issues/97)) ([801ad60](https://github.com/defenseunicorns/uds-software-factory/commit/801ad60f86e0cecb846fb89ed440960f36cf70e7)) 53 | 54 | ## [0.2.6](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.5...v0.2.6) (2024-08-30) 55 | 56 | 57 | ### Miscellaneous 58 | 59 | * **deps:** update swf bundle dependencies ([#94](https://github.com/defenseunicorns/uds-software-factory/issues/94)) ([9a118e1](https://github.com/defenseunicorns/uds-software-factory/commit/9a118e1b0b1664dfb370c4e1b3b23d1d04680e5e)) 60 | 61 | ## [0.2.5](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.4...v0.2.5) (2024-08-20) 62 | 63 | 64 | ### Miscellaneous 65 | 66 | * **deps:** update swf bundle dependencies ([#90](https://github.com/defenseunicorns/uds-software-factory/issues/90)) ([a322421](https://github.com/defenseunicorns/uds-software-factory/commit/a3224213b4cbef7bf1a4523de98098f0557b26d7)) 67 | 68 | ## [0.2.4](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.3...v0.2.4) (2024-08-01) 69 | 70 | 71 | ### Miscellaneous 72 | 73 | * **deps:** update bundle-deps to v3.25.15 ([#86](https://github.com/defenseunicorns/uds-software-factory/issues/86)) ([1ac8afe](https://github.com/defenseunicorns/uds-software-factory/commit/1ac8afe7522b2905be1cca2c5ce594e96bfb565b)) 74 | * **deps:** update swf bundle dependencies ([#89](https://github.com/defenseunicorns/uds-software-factory/issues/89)) ([847f99c](https://github.com/defenseunicorns/uds-software-factory/commit/847f99c71e6f1f96baca5a7ccc51327a4d697ce5)) 75 | * improve the formatting on the README ([#87](https://github.com/defenseunicorns/uds-software-factory/issues/87)) ([64e9fcb](https://github.com/defenseunicorns/uds-software-factory/commit/64e9fcbc0026b415ffb3e2d90026d7de84c470d3)) 76 | 77 | ## [0.2.3](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.2...v0.2.3) (2024-07-23) 78 | 79 | 80 | ### Miscellaneous 81 | 82 | * add alpha warning to Valkey package ([#73](https://github.com/defenseunicorns/uds-software-factory/issues/73)) ([5203f50](https://github.com/defenseunicorns/uds-software-factory/commit/5203f50310ba088f7ad99e5bcbfd18a99e561ec6)) 83 | * add correct task includes on publish ([#81](https://github.com/defenseunicorns/uds-software-factory/issues/81)) ([eff6f2e](https://github.com/defenseunicorns/uds-software-factory/commit/eff6f2e03af8f8aa1387cd2ab63c4384e7f3f2b5)) 84 | * add docs for databases and networking configuration for apps ([#62](https://github.com/defenseunicorns/uds-software-factory/issues/62)) ([8651574](https://github.com/defenseunicorns/uds-software-factory/commit/8651574405509ee34995ed51bc3b59a9771ada11)) 85 | * add valkey to our official repositories on the README ([#71](https://github.com/defenseunicorns/uds-software-factory/issues/71)) ([f5d7450](https://github.com/defenseunicorns/uds-software-factory/commit/f5d745082e050c544d39d3bf2d04ae18caa4c492)) 86 | * adr for build attestations ([#76](https://github.com/defenseunicorns/uds-software-factory/issues/76)) ([8891e9f](https://github.com/defenseunicorns/uds-software-factory/commit/8891e9fd9a57df8bb4b5289c138c49396470eaa5)) 87 | * **deps:** update swf bundle dependencies ([#53](https://github.com/defenseunicorns/uds-software-factory/issues/53)) ([6d9fe10](https://github.com/defenseunicorns/uds-software-factory/commit/6d9fe10931d78a57705d2c193038d2d625ec136b)) 88 | * **deps:** update swf bundle dependencies ([#78](https://github.com/defenseunicorns/uds-software-factory/issues/78)) ([6684e97](https://github.com/defenseunicorns/uds-software-factory/commit/6684e972aad60513e50eab8a2f3ef1e1eb0ac9ea)) 89 | * **deps:** update swf bundle dependencies ([#83](https://github.com/defenseunicorns/uds-software-factory/issues/83)) ([4552e0f](https://github.com/defenseunicorns/uds-software-factory/commit/4552e0fcd854578a2844f09c3bc0ca4a572d07b5)) 90 | * fix bundle path variable on release ([#79](https://github.com/defenseunicorns/uds-software-factory/issues/79)) ([c2ac312](https://github.com/defenseunicorns/uds-software-factory/commit/c2ac3128771a78fc89bdd6341308641068de4c47)) 91 | * fix test task include on publish ([#84](https://github.com/defenseunicorns/uds-software-factory/issues/84)) ([425e4a5](https://github.com/defenseunicorns/uds-software-factory/commit/425e4a5543418ad50a8103eb4fca13e66cc77f33)) 92 | * remove irrelevant comment ([#77](https://github.com/defenseunicorns/uds-software-factory/issues/77)) ([11774e8](https://github.com/defenseunicorns/uds-software-factory/commit/11774e893f22bd94821cd47f8f32fae34cae3599)) 93 | * update license ([#65](https://github.com/defenseunicorns/uds-software-factory/issues/65)) ([0e692b4](https://github.com/defenseunicorns/uds-software-factory/commit/0e692b4e10a8795eb8a4a7dbb8519c5bc4e1afa9)) 94 | 95 | ## [0.2.2](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.1...v0.2.2) (2024-06-07) 96 | 97 | 98 | ### Bug Fixes 99 | 100 | * update uds-core keycloak overrides for demo bundle ([#60](https://github.com/defenseunicorns/uds-software-factory/issues/60)) ([5c7f9fe](https://github.com/defenseunicorns/uds-software-factory/commit/5c7f9fea76ec074a17555109fc55f733e3d27747)) 101 | 102 | ## [0.2.1](https://github.com/defenseunicorns/uds-software-factory/compare/v0.2.0...v0.2.1) (2024-05-30) 103 | 104 | 105 | ### Miscellaneous 106 | 107 | * **deps:** update swf bundle dependencies ([#48](https://github.com/defenseunicorns/uds-software-factory/issues/48)) ([0d3b1f5](https://github.com/defenseunicorns/uds-software-factory/commit/0d3b1f5ab491dd96842aeb4f0eb26030f59038db)) 108 | * remove unecessary configuration options ([#51](https://github.com/defenseunicorns/uds-software-factory/issues/51)) ([0542b9a](https://github.com/defenseunicorns/uds-software-factory/commit/0542b9a49315ed1b9f2c2d8a60f601bf7e018e44)) 109 | * throttle renovate updates to daily ([#49](https://github.com/defenseunicorns/uds-software-factory/issues/49)) ([bcf594f](https://github.com/defenseunicorns/uds-software-factory/commit/bcf594faaf43183bece31d46dd693014ded288c8)) 110 | 111 | ## [0.2.0](https://github.com/defenseunicorns/uds-software-factory/compare/v0.1.3...v0.2.0) (2024-05-10) 112 | 113 | 114 | ### Features 115 | 116 | * add upgrade tests and upgrade packages ([#44](https://github.com/defenseunicorns/uds-software-factory/issues/44)) ([02bab65](https://github.com/defenseunicorns/uds-software-factory/commit/02bab6547e3de814097e6b13f066e108bf7d9d8f)) 117 | 118 | 119 | ### Miscellaneous 120 | 121 | * **deps:** update all dependencies ([#42](https://github.com/defenseunicorns/uds-software-factory/issues/42)) ([9bac28c](https://github.com/defenseunicorns/uds-software-factory/commit/9bac28c92f25ff374666c112386235552e3a290d)) 122 | 123 | ## [0.1.3](https://github.com/defenseunicorns/uds-software-factory/compare/v0.1.2...v0.1.3) (2024-03-22) 124 | 125 | 126 | ### Miscellaneous 127 | 128 | * update readme ([#38](https://github.com/defenseunicorns/uds-software-factory/issues/38)) ([b029a20](https://github.com/defenseunicorns/uds-software-factory/commit/b029a20518d4be5ea3fbb5184432724dd07463a9)) 129 | 130 | ## [0.1.2](https://github.com/defenseunicorns/uds-software-factory/compare/v0.1.1...v0.1.2) (2024-03-22) 131 | 132 | 133 | ### Miscellaneous 134 | 135 | * update to large for publish step ([#35](https://github.com/defenseunicorns/uds-software-factory/issues/35)) ([255e386](https://github.com/defenseunicorns/uds-software-factory/commit/255e386daa9f3dc7cc90280c99cce5bfe56c6232)) 136 | 137 | ## [0.1.1](https://github.com/defenseunicorns/uds-software-factory/compare/v0.1.0...v0.1.1) (2024-03-22) 138 | 139 | 140 | ### Miscellaneous 141 | 142 | * update bad sha in reference to setup action in publish step ([#33](https://github.com/defenseunicorns/uds-software-factory/issues/33)) ([aa85d32](https://github.com/defenseunicorns/uds-software-factory/commit/aa85d32c502d3f65fbcb6ee826be62bb7e30f3aa)) 143 | 144 | ## 0.1.0 (2024-03-22) 145 | 146 | 147 | ### Features 148 | 149 | * add release please ([#31](https://github.com/defenseunicorns/uds-software-factory/issues/31)) ([acd921b](https://github.com/defenseunicorns/uds-software-factory/commit/acd921b0d23a8b405aefd83d2f5515d59d20808b)) 150 | * initial swf bundle implementation ([#25](https://github.com/defenseunicorns/uds-software-factory/issues/25)) ([c4b79ab](https://github.com/defenseunicorns/uds-software-factory/commit/c4b79ab74751f1070a14d250b8df54ef347dee10)) 151 | 152 | 153 | ### Miscellaneous 154 | 155 | * add a reference to the postgresql operator ([#27](https://github.com/defenseunicorns/uds-software-factory/issues/27)) ([873c5b2](https://github.com/defenseunicorns/uds-software-factory/commit/873c5b2cbe7c3b13203f4d4adc4d605ef1bf5b3c)) 156 | * add docs for versioning and testing ([#21](https://github.com/defenseunicorns/uds-software-factory/issues/21)) ([8aae272](https://github.com/defenseunicorns/uds-software-factory/commit/8aae272c6672454c2d62c96716e3b392c1004c9f)) 157 | * add initial shared renovate config ([#23](https://github.com/defenseunicorns/uds-software-factory/issues/23)) ([3f09ead](https://github.com/defenseunicorns/uds-software-factory/commit/3f09eadcad4a7c7a243b4709c512294dc26baea4)) 158 | * initial repo setup ([1300638](https://github.com/defenseunicorns/uds-software-factory/commit/13006386410daf91f164512cf4f56a29326d40d9)) 159 | * update CODEOWNERS to new style/group ([#26](https://github.com/defenseunicorns/uds-software-factory/issues/26)) ([7a64cf7](https://github.com/defenseunicorns/uds-software-factory/commit/7a64cf79dfb7a1de3689f6f567e2fee85449f9b6)) 160 | * Update README.md ([#8](https://github.com/defenseunicorns/uds-software-factory/issues/8)) ([5265bf8](https://github.com/defenseunicorns/uds-software-factory/commit/5265bf8478824773ad8a840d626a4d7cf6d097b1)) 161 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------