doc improvements / adding missing goreleaser config (#19)

* docs / missing goreleaser config

* fix default ports in chart

Author: raffis

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+## Current situation
+<!--- Shortly describe the current situation -->
+
+## Proposal
+<!--- Describe what this PR is intended to achieve -->

.goreleaser.yaml

@@ -0,0 +1,39 @@
+project_name: k8sdb-controller
+
+builds:
+  - skip: true
+
+release:
+  prerelease: "true"
+  extra_files:
+    - glob: config/release/*.yaml
+
+checksum:
+  extra_files:
+    - glob: config/release/*.yaml
+
+source:
+  enabled: true
+  name_template: "{{ .ProjectName }}_{{ .Version }}_source_code"
+
+sboms:
+  - id: source
+    artifacts: source
+    documents:
+      - "{{ .ProjectName }}_{{ .Version }}_sbom.spdx.json"
+
+# signs the checksum file
+# all files (including the sboms) are included in the checksum
+# https://goreleaser.com/customization/sign
+#signs:
+#  - cmd: cosign
+#   env:
+#      - COSIGN_EXPERIMENTAL=1
+#    certificate: "${artifact}.pem"
+#    args:
+#      - sign-blob
+#      - "--output-certificate=${certificate}"
+#      - "--output-signature=${signature}"
+#      - "${artifact}"
+#    artifacts: checksum
+#    output: true

CHANGELOG.md

@@ -2,12 +2,6 @@
 
 ## 0.1.0
 
-**Release date:** xxxx-xx-xx
+**Release date:** 2022-02-24
 
-description
-
-Improvements:
-* xxx
-
-Fixes:
-* xxx
+Initial oss release

CONTRIBUTING.md

@@ -1,11 +1,18 @@
 ## Release process
 
+### Controller release
 1. Merge all pr's to master which need to be part of the new release
 2. Create pr to master with these changes:
+  1. Bump kustomization
+  2. Create CHANGELOG.md entry with release and date
+3. Merge pr
+4. Push a tag following semantic versioning prefixed by 'v'. Do not create a github release, this is done automatically.
+5. Create new branch and add the following changes:
   1. Bump chart version
   2. Bump charts app version
-  3. Bump kustomization
-  4. Create CHANGELOG.md entry with release and date
-3. Merge pr
-4. Push a tag following semantic versioning prefixed by 'v'.
-Do not create a github release, this is done automatically.
+6. Create pr to master and merge
+
+### Helm chart change only
+1. Create branch with changes
+2. Bump chart version
+3. Create pr to master and merge

README.md

@@ -1,17 +1,20 @@
 # Database controller
 
-[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4787/badge)](https://bestpractices.coreinfrastructure.org/projects/4787)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5643/badge)](https://bestpractices.coreinfrastructure.org/projects/5643)
 [![e2e](https://github.com/DoodleScheduling/k8sdb-controller/workflows/e2e/badge.svg)](https://github.com/DoodleScheduling/k8sdb-controller/actions)
 [![report](https://goreportcard.com/badge/github.com/DoodleScheduling/k8sdb-controller)](https://goreportcard.com/report/github.com/DoodleScheduling/k8sdb-controller)
-[![license](https://img.shields.io/github/license/DoodleScheduling/k8sdb-controller.svg)](https://github.com/DoodleScheduling/k8sdb-controller/blob/main/LICENSE)
+[![license](https://img.shields.io/github/license/DoodleScheduling/k8sdb-controller.svg)](https://github.com/DoodleScheduling/k8sdb-controller/blob/master/LICENSE)
 [![release](https://img.shields.io/github/release/DoodleScheduling/k8sdb-controller/all.svg)](https://github.com/DoodleScheduling/k8sdb-controller/releases)
 
 Kubernetes Controller for database and user provisioning.
-
-**Note**: This controller does not deploy database servers. It is meant for managing existing ones either deployed by other controllers or manually.
+Currently the controller supports Postgres and MongoDB (as well as MongoDB Atlas).
+Using the controller you can deploy databases and users defined as code on top of kubernetes.
+How to deploy database servers is out of scope of this project.
 
 ## Example for PostgreSQL
 
+Example of how to deploy a Postgres database called my-app as well as a user to the server localhost:5432.
+
 ```yaml
 apiVersion: v1
 kind: Secret
@@ -54,6 +57,9 @@ data:
 ```
 
 ## Example for MongoDB
+
+Example of how to deploy a MongoDB database called my-app as well as a user to the server localhost:5432.
+
 ```yaml
 apiVersion: v1
 kind: Secret
@@ -97,29 +103,40 @@ data:
   username: MTIzNA==
 ```
 
-## Helm chart
+## Installation
+
+### Helm
+
+Please see [chart/k8sdb-controller](https://github.com/DoodleScheduling/k8sdb-controller/tree/master/chart/k8stcpmap-controller) for the helm chart docs.
+
+### Manifests/kustomize
 
-Please see [chart/k8sdb-controller](https://github.com/DoodleScheduling/k8sdb-controller) for the helm chart docs.
+Alternatively you may get the bundled manifests in each release to deploy it using kustomize or use them directly.
+
+## Limitations
+
+By design there is no garbage collection implemented for databases. Meaning a database does not get dropped if the kubernetes resources is removed.
+However this is not the case for users. Users will be removed from the corresponding databases if the referenced kubernetes resource gets removed.
+We might reconsider this in the future.
 
 ## Profiling
-To profile controller, access web server on #profilerPort (default 6060). 
+To profile controller, access web server on #profilerPort (default 6060).
 
 In Kubernetes, port-forward to this port, and open the `/debug/pprof` URL in browser. For example, if you port-forward 6060 from container to 6060 on your machine, access:
 ```
 http://localhost:6060/debug/pprof/
 ```
 
-## Limitations
-
-Currently there is no garbage collection implemented, meaning all the things created are not removed.
-This will be at least implemented for user provisioning. Discussion will stay open for databases.
-
 ## Configure the controller
 
-ENV Variable | Argument | Default value | Example | Purpose |
--------------|----------|---------------|---------|---------|
-METRICS_ADDR | --metrics-addr | :8080 | :8080 | Metrics port |
-ENABLE_LEADER_ELECTION | --enable-leader-election | false | true | Enable leader election |
-LEADER_ELECTION_NAMESPACE | --leader-election-namespace | "" | devops | Leader election namespace. Default is the same as controller.
-NAMESPACES | --namespaces | "" | devops,default |  Namespaces to watch. Default: watch all namespaces |
-MAX_CONCURRENT_RECONCILES | --max-concurrent-reconciles | 1 | 5 | Maximum concurrent reconciles per controller. This config covers all controllers. |
+You may change base settings for the controller using env variables (or alternatively command line arguments).
+Available env variables:
+
+| Name  | Description | Default |
+|-------|-------------| --------|
+| `METRICS_ADDR` | The address of the metric endpoint binds to. | `:9556` |
+| `PROBE_ADDR` | The address of the probe endpoints binds to. | `:9557` |
+| `ENABLE_LEADER_ELECTION` | Enable leader election for controller manager. | `false` |
+| `LEADER_ELECTION_NAMESPACE` | Change the leader election namespace. This is by default the same where the controller is deployed. | `` |
+| `NAMESPACES` | The controller listens by default for all namespaces. This may be limited to a comma delimited list of dedicated namespaces. | `` |
+| `CONCURRENT` | The number of concurrent reconcile workers.  | `1` |

chart/k8sdb-controller/Chart.yaml

@@ -12,4 +12,4 @@ keywords:
 name: k8sdb-controller
 sources:
 - https://github.com/DoodleScheduling/k8sdb-controller
-version: 0.1.0
+version: 0.1.1

chart/k8sdb-controller/README.md

@@ -7,16 +7,16 @@ Installs the [k8sdb-controller](https://github.com/DoodleScheduling/k8sdb-contro
 To install the chart with the release name `k8sdb-controller`:
 
 ```console
+helm repo add k8sdb-controller https://doodlescheduling.github.io/k8sdb-controller/
 helm upgrade --install k8sdb-controller chart/k8sdb-controller
 ```
 
 This command deploys the k8sdb-controller with the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
 
 ## Using the Chart
 
-The chart comes with a ServiceMonitor for use with the [Prometheus Operator](https://github.com/helm/charts/tree/master/stable/prometheus-operator).
-If you're not using the Prometheus Operator, you can disable the ServiceMonitor by setting `serviceMonitor.enabled` to `false` and instead
-populate the `podAnnotations` as below:
+The chart comes with a ServiceMonitor/PodMonitor for use with the [Prometheus Operator](https://github.com/coreos/prometheus-operator) which are disabled by default.
+If you're not using the Prometheus Operator, you can populate the `podAnnotations` as below:
 
 ```yaml
 podAnnotations:

chart/k8sdb-controller/values.yaml

@@ -37,8 +37,8 @@ podAnnotations: {}
 #  prometheus.io/scrape: "true"
 #  prometheus.io/port: "metrics"
 
-metricsPort: "8080"
-probesPort: "9558"
+metricsPort: "9556"
+probesPort: "9557"
 profilerPort: "6060"
 
 # Change the metrics path