Tor crd 0.6.1

.cliff.toml

@@ -0,0 +1,65 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/bugfest/tor-controller/issues/${2}))"},
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { message = ".*", group = "Generic"},
+    { body = ".*security", group = "Security"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "[0-9]*"
+# regex for skipping tags
+skip_tags = "0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags chronologically
+date_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

CHANGELOG.md

@@ -1,80 +1,199 @@
 # Changelog
 
-## [0.5.1](https://github.com/bugfest/tor-controller/tree/0.5.1) (2022-03-10)
+All notable changes to this project will be documented in this file.
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/tor-controller-0.1.3...0.5.1)
+## [0.6.1] - 2022-07-28
 
-**Fixed bugs:**
+### Bug Fixes
 
-- \[BUG\] trying to consume secret for private key fails [\#13](https://github.com/bugfest/tor-controller/issues/13)
-- \[BUG\] echoserver is not multiarch [\#12](https://github.com/bugfest/tor-controller/issues/12)
-- \[BUG\] Manager pod failing to start for arm64 install [\#11](https://github.com/bugfest/tor-controller/issues/11)
+- Tor-controller service account ref in Tor-pod instance
+- Helm chart project config. ClusterRole update. Default Tor daemon image
 
-**Merged pull requests:**
+### Generic
 
-- Fixes \#13 - Bring your own key [\#14](https://github.com/bugfest/tor-controller/pull/14) ([bugfest](https://github.com/bugfest))
+- [ci-skip] Updated helm chart to use version 0.6.0
 
-## [tor-controller-0.1.3](https://github.com/bugfest/tor-controller/tree/tor-controller-0.1.3) (2022-02-20)
+- Merge branch 'tor-crd' into tor-crd-0.6.1
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/0.5.0...tor-controller-0.1.3)
+- Tor spec and controller implementation alpha
 
-## [0.5.0](https://github.com/bugfest/tor-controller/tree/0.5.0) (2022-02-20)
+- Tor daemon services multiple address support. Listen address and policies using IPv4/IPv6 dual stack.
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/0.4.0...0.5.0)
 
-**Implemented enhancements:**
+### Miscellaneous Tasks
 
-- Metrics exporters and service monitors [\#10](https://github.com/bugfest/tor-controller/pull/10) ([bugfest](https://github.com/bugfest))
+- Use git-cliff to generate CHANGELOG
+- Better git-cliff docker command
 
-## [0.4.0](https://github.com/bugfest/tor-controller/tree/0.4.0) (2022-02-10)
+## [0.6.0] - 2022-07-12
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/tor-controller-0.1.2...0.4.0)
+### Features
 
-## [tor-controller-0.1.2](https://github.com/bugfest/tor-controller/tree/tor-controller-0.1.2) (2022-02-10)
+- Add tor service pod template ([#18](https://github.com/bugfest/tor-controller/issues/18))
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/tor-controller-0.1.1...tor-controller-0.1.2)
+### Generic
 
-**Implemented enhancements:**
+- [ci-skip] Updated helm chart to use version 0.5.1
 
-- \[REQUEST\] OnionBalancedService [\#8](https://github.com/bugfest/tor-controller/issues/8)
+- Tor Spec draft
 
-**Merged pull requests:**
+- WIP - tor_controller schematic
 
-- Onionbalancedservice [\#9](https://github.com/bugfest/tor-controller/pull/9) ([bugfest](https://github.com/bugfest))
+- Tor-crd WIP
 
-## [tor-controller-0.1.1](https://github.com/bugfest/tor-controller/tree/tor-controller-0.1.1) (2022-01-29)
+- * Updating dependencies - version v0.6.0
+* Updating Helm Chart - preparing helm chart version v0.1.5
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/0.3.2...tor-controller-0.1.1)
 
-**Implemented enhancements:**
+## [0.5.1] - 2022-03-10
 
-- No arm64 containers [\#3](https://github.com/bugfest/tor-controller/issues/3)
+### Generic
 
-## [0.3.2](https://github.com/bugfest/tor-controller/tree/0.3.2) (2022-01-29)
+- [ci-skip] Update changelog - v0.5.0
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/tor-controller-0.1.0...0.3.2)
+- [ci-skip] Fixes #11
+Updated multiarch dockerfiles.
+Tor is compiled in a separate project: bugfest/tor-docker to speed up the build times
+Added QEMU/arm64 how to
 
-**Merged pull requests:**
+- [skip-ci] Fixes #12 Use bugfest/echoserver (multiarch) instead of google's
+Add QEMU arm64 instructions to get a k3s sanbox
 
-- Fixing tags typo [\#6](https://github.com/bugfest/tor-controller/pull/6) ([bugfest](https://github.com/bugfest))
-- Update action branch: master [\#4](https://github.com/bugfest/tor-controller/pull/4) ([bugfest](https://github.com/bugfest))
+- Tor-crd WIP
 
-## [tor-controller-0.1.0](https://github.com/bugfest/tor-controller/tree/tor-controller-0.1.0) (2022-01-29)
+- WIP
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/0.3.1...tor-controller-0.1.0)
+- Fixes #13 - Bring your own key ([#14](https://github.com/bugfest/tor-controller/issues/14))
 
-**Implemented enhancements:**
 
-- Helm chart for installing? [\#1](https://github.com/bugfest/tor-controller/issues/1)
 
-**Merged pull requests:**
+## [0.5.0] - 2022-02-20
 
-- Helm chart for installing [\#2](https://github.com/bugfest/tor-controller/pull/2) ([bugfest](https://github.com/bugfest))
+### Generic
 
-## [0.3.1](https://github.com/bugfest/tor-controller/tree/0.3.1) (2022-01-05)
+- [ci-skip] Update changelog
 
-[Full Changelog](https://github.com/bugfest/tor-controller/compare/e261c6b6023685063774c7264b86f8d5b71d29b2...0.3.1)
+- [ci-skip] TOR is Tor. Updated roadmap
 
+- Tor updated to version 0.4.6.10 ([#10](https://github.com/bugfest/tor-controller/issues/10))
 
+Metrics exporters (controller and managers)
+Helm chart service monitor creation (controller)
+Updated CRDs to enable Service Monitor creation
 
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+## [0.4.0] - 2022-02-10
+
+### Generic
+
+- [ci-skip] reverting chart version
+
+- [ci-skip] App version 0.3.2, Chart version 0.1.1
+
+- [ci-skip] Updated Chart Readme
+
+- [ci-skip] Update issue templates
+- [ci-skip] Updated Changelog
+
+- [ci-skip] Updated helm chart dir in Makefile
+
+- [ci-skip] Updated versions and badges
+
+- OnionBalancedService Initial implementation
+
+- Fix tor reloading crash-loop
+
+- Remove unused function
+
+- Add short names for OnionServices: onion,os and OnionBalancedServices: onionha,oha,obs
+
+- Manager role requires ConfigMap access
+
+- Cleanup and minor fixes
+
+- Helm chart updates
+
+- Helm chart README update
+
+- OnionBalancedService How-To
+
+- Document tor-onionbalance-manager image
+
+- Update workflows to build tor-onionbalance-manager
+
+- Merge pull request #9 from bugfest/onionbalancedservice
+
+OnionBalancedService implementation - Fixes #8 
+
+## [0.3.2] - 2022-01-29
+
+### Generic
+
+- #1 Helm chart for installing
+
+- Merge pull request #2 from bugfest/helm
+
+Helm chart for installing. Fixes #1 
+- Updated CHANGELOG
+
+- Preparing chart-releaser-action changes
+
+- Updating chart repo URL and instructions
+
+- Update action branch: master
+
+- Update action branch: master
+
+- Merge pull request #4 from bugfest/multiarch
+
+Update action branch: master
+- Fixing tags typo
+
+- Merge pull request #6 from bugfest/multiarch
+
+Fixing tags typo
+- [ci-skip] add multiarch build-tag workflow
+
+- App version 0.3.2, Chart version 0.1.1
+
+- Testing CI workflows with a blank commit
+
+
+## [0.3.1] - 2022-01-05
+
+### Bug Fixes
+
+- Fix repo url references
+
+
+### Generic
+
+- Initial migration
+
+- Initial v1alpha2
+
+- ProjectConfig initial
+
+- ProjectConfig fix crd
+
+- Projectconfig and manager rbac working
+
+- Get out-of-cluster run work again
+
+- Migrating agents
+
+- V1alpha2 e2e test working
+
+- Update some links
+
+- Improved objects sync
+
+- Added README and LICENSE. Cleaned up old samples
+
+- Generate install manifest
+
+- Update docker container refs
+
+- Integrated install manifests
+
+
+<!-- generated by git-cliff -->

Dockerfile.tor-daemon

@@ -0,0 +1,4 @@
+ARG TOR_VERSION="0.4.6.10"
+ARG TOR_IMAGE="quay.io/bugfest/tor"
+
+FROM ${TOR_IMAGE}:${TOR_VERSION} as tor

Makefile

@@ -77,6 +77,12 @@ run: manifests generate fmt vet ## Run a controller from your host.
 rundev: manifests generate fmt vet ## Run a controller from your host.
 	go run ./main.go -no-leader-elect --config config/manager/controller_manager_config_dev.yaml
 
+.PHONY: docker-build-all
+docker-build-all: docker-build docker-build-daemon docker-build-daemon-manager docker-build-onionbalance-manager
+
+.PHONY: docker-push-all
+docker-push-all: docker-push docker-push-daemon docker-push-daemon-manager docker-push-onionbalance-manager
+
 .PHONY: docker-build
 docker-build: test ## Build docker image with the manager.
 	docker build -t ${IMG} -f Dockerfile .
@@ -87,19 +93,27 @@ docker-push: ## Push docker image with the manager.
 
 .PHONY: docker-build-daemon
 docker-build-daemon:
-	docker build -t ${IMG_DAEMON} -f Dockerfile.tor-daemon-manager .
+	docker build -t ${IMG_DAEMON} -f Dockerfile.tor-daemon .
 
 .PHONY: docker-push-daemon
  docker-push-daemon:
 	docker push ${IMG_DAEMON}
 
-.PHONY: docker-build-onionbalance
-docker-build-onionbalance:
-	docker build -t ${IMG_ONIONBALANCE} -f Dockerfile.tor-onionbalance-manager .
+.PHONY: docker-build-daemon-manager
+docker-build-daemon-manager:
+	docker build -t ${IMG_DAEMON_MANAGER} -f Dockerfile.tor-daemon-manager .
+
+.PHONY: docker-push-daemon-manager
+ docker-push-daemon-manager:
+	docker push ${IMG_DAEMON_MANAGER}
+
+.PHONY: docker-build-onionbalance-manager
+docker-build-onionbalance-manager:
+	docker build -t ${IMG_ONIONBALANCE_MANAGER} -f Dockerfile.tor-onionbalance-manager .
 
-.PHONY: docker-push-onionbalance
-docker-push-onionbalance:
-	docker push ${IMG_ONIONBALANCE}
+.PHONY: docker-push-onionbalance-manager
+docker-push-onionbalance-manager:
+	docker push ${IMG_ONIONBALANCE_MANAGER}
 
 ##@ Deployment
 
@@ -170,7 +184,7 @@ installer: manifests kustomize ## Install CRDs into the K8s cluster specified in
 	$(KUSTOMIZE) build config/default --output $(INSTALLER)
 
 .PHONY: helm
-helm: installer yq
+helm: installer helm-readme yq
 	$(YQ) '. | select(.kind == "CustomResourceDefinition")' $(INSTALLER) > charts/tor-controller/templates/customresourcedefinition.yaml
 ##@ $(YQ) '. | select(.kind == "Namespace")' $(INSTALLER) > charts/tor-controller/templates/namespace.yaml
 ##@ $(YQ) '. | select(.kind == "ServiceAccount")' $(INSTALLER) > charts/tor-controller/templates/serviceaccount.yaml
@@ -181,3 +195,14 @@ helm: installer yq
 ##@ $(YQ) '. | select(.kind == "ConfigMap")' $(INSTALLER) > charts/tor-controller/templates/configmap.yaml
 ##@ $(YQ) '. | select(.kind == "Service")' $(INSTALLER) > charts/tor-controller/templates/service.yaml
 ##@ $(YQ) '. | select(.kind == "Deployment")' $(INSTALLER) > charts/tor-controller/templates/deployment.yaml
+
+.PHONE: helm-readme
+helm-readme:
+	docker run --rm --volume "${PWD}/charts":/helm-docs:ro jnorwood/helm-docs:latest --dry-run > charts/tor-controller/README.md
+
+.PHONE: changelog
+changelog:
+	docker run -t -v "${PWD}":/app/ orhunp/git-cliff:latest -c .cliff.toml -o CHANGELOG.md
+
+.PHONE: release
+release: installer changelog helm

PROJECT

@@ -40,4 +40,13 @@ resources:
   kind: ProjectConfig
   path: github.com/bugfest/tor-controller/apis/config/v2
   version: v2
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: k8s.torproject.org
+  group: tor
+  kind: Tor
+  path: github.com/bugfest/tor-controller/apis/tor/v1alpha2
+  version: v1alpha2
 version: "3"