Initial commit

Gabriel Mainberger · Gabriel Mainberger · commit 2606b0b57944 · 2020-09-14T15:35:32.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md
@@ -0,0 +1,20 @@
+---
+name: 🐜 Bug report
+about: Create a report to help us improve 🔧
+labels: bug
+---
+
+<!-- Place a general description or your issue here. -->
+
+## Steps to Reproduce the Problem
+<!-- Tell us how to reproduce your issue -->
+
+  1.
+  1.
+  1.
+
+## Actual Behavior
+<!-- What did happen as a result of the above? -->
+
+## Expected Behavior
+<!-- What is your expectation of the result? -->
diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md
@@ -0,0 +1,18 @@
+---
+name: 🚀 Feature request
+about: Suggest an idea for this project 💡
+labels: enhancement
+---
+
+## Context
+<!--
+Please let us know what you are trying to do and how you would want to do it differently?
+Is it something you currently cannot do?
+Is this related to an issue/problem?
+-->
+
+## Alternatives
+<!--
+Can you achieve the same result doing it in an alternative way?
+Is the alternative considerable?
+-->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ❓ Help and Support RocketChat Channel
+    url: https://community.appuio.ch
+    about: Please ask and answer questions here. 🏥
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,21 @@
+<!--
+Thank you for your pull request. Please provide a description above and
+review the checklist below.
+
+Contributors guide: ./CONTRIBUTING.md
+-->
+
+## Checklist
+<!--
+Remove items that do not apply. For completed items, change [ ] to [x].
+-->
+
+- [ ] Keep pull requests small so they can be easily reviewed.
+- [ ] Update the documentation.
+- [ ] Update the ./CHANGELOG.md.
+- [ ] Link this PR to related issues.
+
+<!--
+NOTE: these things are not required to open a PR and can be done afterwards,
+while the PR is open.
+-->
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,19 @@
+name: Pull Request
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        command:
+          - lint_jsonnet
+          - lint_yaml
+          - docs
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run ${{ matrix.command }}
+        run: make ${{ matrix.command }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+_archive/
+_public/
+.cache/
+helmcharts/
+manifests/
diff --git a/.yamllint.yml b/.yamllint.yml
@@ -0,0 +1,7 @@
+extends: default
+
+rules:
+  # 80 chars should be enough, but don't fail if a line is longer
+  line-length:
+    max: 80
+    level: warning
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+
+- …
+
+[Unreleased]: https://github.com/projectsyn/component-system-upgrade-controller/compare/v0.1.0...HEAD
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,4 @@
+# Code of Conduct
+
+This code repository is part of Project Syn and the code of conduct at
+https://syn.tools/syn/code_of_conduct.html does apply.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,6 @@
+# How to contribute
+
+This code repository is part of Project Syn and the contribution guide at
+https://syn.tools/syn/contribution_guide.html does apply.
+
+Submit Pull Requests at https://github.com/projectsyn/component-system-upgrade-controller/pulls.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,27 @@
+Copyright 2020, VSHN AG <info@vshn.ch>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,55 @@
+MAKEFLAGS += --warn-undefined-variables
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
+.DELETE_ON_ERROR:
+.SUFFIXES:
+
+DOCKER_CMD   ?= docker
+DOCKER_ARGS  ?= run --rm --user "$$(id -u)" -v "$${PWD}:/component" --workdir /component
+
+JSONNET_FILES   ?= $(shell find . -type f -name '*.*jsonnet' -or -name '*.libsonnet')
+JSONNETFMT_ARGS ?= --in-place
+JSONNET_IMAGE   ?= docker.io/bitnami/jsonnet:latest
+JSONNET_DOCKER  ?= $(DOCKER_CMD) $(DOCKER_ARGS) --entrypoint=jsonnetfmt $(JSONNET_IMAGE)
+
+YAML_FILES      ?= $(shell find . -type f -name '*.yaml' -or -name '*.yml')
+YAMLLINT_ARGS   ?= --no-warnings
+YAMLLINT_CONFIG ?= .yamllint.yml
+YAMLLINT_IMAGE  ?= docker.io/cytopia/yamllint:latest
+YAMLLINT_DOCKER ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(YAMLLINT_IMAGE)
+
+VALE_CMD  ?= $(DOCKER_CMD) $(DOCKER_ARGS) --volume "$${PWD}"/docs/modules:/pages vshn/vale:2.1.1
+VALE_ARGS ?= --minAlertLevel=error --config=/pages/ROOT/pages/.vale.ini /pages
+
+ANTORA_PREVIEW_CMD ?= $(DOCKER_CMD) run --rm --publish 2020:2020 --volume "${PWD}":/antora vshn/antora-preview:2.3.3 --style=syn --antora=docs
+
+.PHONY: all
+all: lint open
+
+.PHONY: lint
+lint: lint_jsonnet lint_yaml docs-vale
+
+.PHONY: lint_jsonnet
+lint_jsonnet: $(JSONNET_FILES)
+	$(JSONNET_DOCKER) $(JSONNETFMT_ARGS) --test -- $?
+
+.PHONY: lint_yaml
+lint_yaml: $(YAML_FILES)
+	$(YAMLLINT_DOCKER) -f parsable -c $(YAMLLINT_CONFIG) $(YAMLLINT_ARGS) -- $?
+
+.PHONY: format
+format: format_jsonnet
+
+.PHONY: format_jsonnet
+format_jsonnet: $(JSONNET_FILES)
+	$(JSONNET_DOCKER) $(JSONNETFMT_ARGS) -- $?
+
+.PHONY: docs-serve
+docs-serve:
+	$(ANTORA_PREVIEW_CMD)
+
+.PHONY: docs-vale
+docs-vale:
+	$(VALE_CMD) $(VALE_ARGS)
+
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# Commodore Component: system-upgrade-controller
+
+This is a [Commodore][commodore] Component for system-upgrade-controller.
+
+This repository is part of Project Syn.
+For documentation on Project Syn and this component, see https://syn.tools.
+
+## Documentation
+
+Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora].
+It is located in the [docs/](docs) folder.
+The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content.
+
+Run the `make docs-serve` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation.
+
+After writing the documentation, please use the `make docs-vale` command and correct any warnings raised by the tool.
+
+## Contributing and license
+
+This library is licensed under [BSD-3-Clause](LICENSE).
+For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md).
+
+[commodore]: https://docs.syn.tools/commodore/index.html
+[asciidoc]: https://asciidoctor.org/
+[antora]: https://antora.org/
diff --git a/class/defaults.yml b/class/defaults.yml
@@ -0,0 +1,3 @@
+parameters:
+  system_upgrade_controller:
+    namespace: syn-system-upgrade-controller
diff --git a/class/system-upgrade-controller.yml b/class/system-upgrade-controller.yml
@@ -0,0 +1,11 @@
+parameters:
+  kapitan:
+    compile:
+      - input_paths:
+          - system-upgrade-controller/component/app.jsonnet
+        input_type: jsonnet
+        output_path: apps/
+      - input_paths:
+          - system-upgrade-controller/component/main.jsonnet
+        input_type: jsonnet
+        output_path: system-upgrade-controller/
diff --git a/component/app.jsonnet b/component/app.jsonnet
@@ -0,0 +1,10 @@
+local kap = import 'lib/kapitan.libjsonnet';
+local inv = kap.inventory();
+local params = inv.parameters.system_upgrade_controller;
+local argocd = import 'lib/argocd.libjsonnet';
+
+local app = argocd.App('system-upgrade-controller', params.namespace);
+
+{
+  'system-upgrade-controller': app,
+}
diff --git a/component/main.jsonnet b/component/main.jsonnet
@@ -0,0 +1,10 @@
+// main template for system-upgrade-controller
+local kap = import 'lib/kapitan.libjsonnet';
+local kube = import 'lib/kube.libjsonnet';
+local inv = kap.inventory();
+// The hiera parameters for the component
+local params = inv.parameters.system_upgrade_controller;
+
+// Define outputs below
+{
+}
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -0,0 +1,6 @@
+name: system-upgrade-controller
+title: system-upgrade-controller
+version: master
+start_page: ROOT:index.adoc
+nav:
+  - modules/ROOT/partials/nav.adoc
diff --git a/docs/modules/ROOT/pages/explanations/.gitkeep b/docs/modules/ROOT/pages/explanations/.gitkeep
diff --git a/docs/modules/ROOT/pages/how-tos/.gitkeep b/docs/modules/ROOT/pages/how-tos/.gitkeep
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -0,0 +1,5 @@
+= system-upgrade-controller
+
+system-upgrade-controller is a Commodore component to manage system-upgrade-controller.
+
+See the xref:references/parameters.adoc[parameters] reference for further details.
diff --git a/docs/modules/ROOT/pages/references/parameters.adoc b/docs/modules/ROOT/pages/references/parameters.adoc
@@ -0,0 +1,19 @@
+= Parameters
+
+The parent key for all of the following parameters is `system_upgrade_controller`.
+
+== `namespace`
+
+[horizontal]
+type:: string
+default:: `syn-system-upgrade-controller`
+
+The namespace in which to deploy this component.
+
+
+== Example
+
+[source,yaml]
+----
+namespace: example-namespace
+----
diff --git a/docs/modules/ROOT/pages/tutorials/.gitkeep b/docs/modules/ROOT/pages/tutorials/.gitkeep
diff --git a/docs/modules/ROOT/partials/nav.adoc b/docs/modules/ROOT/partials/nav.adoc
@@ -0,0 +1,2 @@
+* xref:index.adoc[Home]
+* xref:references/parameters.adoc[Parameters]
