From 81ea811f9275c1ee528370c4fea80d57062dc476 Mon Sep 17 00:00:00 2001 From: Gabriel Saratura Date: Mon, 11 Nov 2024 11:24:51 +0100 Subject: [PATCH] Remove antora docs --- Makefile | 4 ---- Makefile.vars.mk | 2 -- README.md | 2 +- docs/antora.yml | 6 ------ .../images/application-logic.drawio.svg | 4 ---- .../ROOT/pages/explanations/data-usage.adoc | 19 ------------------ .../ROOT/pages/how-tos/installation.adoc | 20 ------------------- docs/modules/ROOT/pages/index.adoc | 7 ------- docs/modules/ROOT/partials/nav.adoc | 4 ---- 9 files changed, 1 insertion(+), 67 deletions(-) delete mode 100644 docs/antora.yml delete mode 100644 docs/modules/ROOT/assets/images/application-logic.drawio.svg delete mode 100644 docs/modules/ROOT/pages/explanations/data-usage.adoc delete mode 100644 docs/modules/ROOT/pages/how-tos/installation.adoc delete mode 100644 docs/modules/ROOT/pages/index.adoc delete mode 100644 docs/modules/ROOT/partials/nav.adoc diff --git a/Makefile b/Makefile index 59fb530..f77c508 100644 --- a/Makefile +++ b/Makefile @@ -32,10 +32,6 @@ build-docker: ## Build docker image go build -o ${BIN_FILENAME} $(DOCKER_CMD) build --platform $(DOCKER_IMAGE_GOOS)/$(DOCKER_IMAGE_GOARCH) -t $(CONTAINER_IMG) . -.PHONY: docs-serve -docs-serve: ## Preview the documentation - $(ANTORA_PREVIEW_CMD) - .PHONY: test test: test-go ## All-in-one test diff --git a/Makefile.vars.mk b/Makefile.vars.mk index 0007f60..1657a3c 100644 --- a/Makefile.vars.mk +++ b/Makefile.vars.mk @@ -19,8 +19,6 @@ IMG_TAG ?= latest # Image URL to use all building/pushing image targets CONTAINER_IMG ?= ghcr.io/$(PROJECT_OWNER)/$(PROJECT_NAME):$(IMG_TAG) -ANTORA_PREVIEW_CMD ?= $(DOCKER_CMD) run --rm --publish 35729:35729 --publish 2020:2020 --volume "${PWD}/.git":/preview/antora/.git --volume "${PWD}/docs":/preview/antora/docs ghcr.io/vshn/antora-preview --style=syn --antora=docs - # TEST:integration ENVTEST_ADDITIONAL_FLAGS ?= --bin-dir "$(go_bin)" # See https://storage.googleapis.com/kubebuilder-tools/ for list of supported K8s versions diff --git a/README.md b/README.md index 336fef7..ead8720 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Batch job to sync usage data from the Exoscale and Cloudscale API to Odoo16. Metrics are collected based on [metered billing data flow](https://docs.central.vshn.ch/metered-billing-data-flow.html) -See the [component documentation](https://hub.syn.tools/billing-collector-cloudservices/index.html) for more information. +See the [documentation](https://kb.vshn.ch/app-catalog/reference/cloud-usage-reporting.html) for more information. ## APPUiO Cloud vs APPUiO Managed diff --git a/docs/antora.yml b/docs/antora.yml deleted file mode 100644 index 6b99613..0000000 --- a/docs/antora.yml +++ /dev/null @@ -1,6 +0,0 @@ -name: billing-collector-cloudservices -title: billing-collector-cloudservices -version: master -start_page: ROOT:index.adoc -nav: - - modules/ROOT/partials/nav.adoc diff --git a/docs/modules/ROOT/assets/images/application-logic.drawio.svg b/docs/modules/ROOT/assets/images/application-logic.drawio.svg deleted file mode 100644 index ea1633b..0000000 --- a/docs/modules/ROOT/assets/images/application-logic.drawio.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Exoscale buckets with usage size
Exoscale buckets...
K8s buckets with namespace and organisation
K8s buckets with...
Match by name
Match by name
postgres billing database
postgres billin...
Aggregate usage storage by namespace
Aggregate usage stor...Text is not SVG - cannot display \ No newline at end of file diff --git a/docs/modules/ROOT/pages/explanations/data-usage.adoc b/docs/modules/ROOT/pages/explanations/data-usage.adoc deleted file mode 100644 index 10c37b6..0000000 --- a/docs/modules/ROOT/pages/explanations/data-usage.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= Data Usage - -WARNING: This page is outdated and the information below is not correct anymore. - -This page gives a brief overview how resources data usage (e.g. buckets) is saved to the postgres billing database. - -== Data flow - -image::application-logic.drawio.svg[] - -== Data source -- Resources (e.g. buckets, DBaaS, ...) are fetched from Exoscale Provider and K8s Cluster. -- The resource names in Exoscale are unique across organisation which prevents clusters having same resource names. - -== Data saving - -- The data is saved in a postgres database. -- A database must be provided in the postgres URL. -- The application ensures the initial configuration of specified database in the URL. diff --git a/docs/modules/ROOT/pages/how-tos/installation.adoc b/docs/modules/ROOT/pages/how-tos/installation.adoc deleted file mode 100644 index 5895b2f..0000000 --- a/docs/modules/ROOT/pages/how-tos/installation.adoc +++ /dev/null @@ -1,20 +0,0 @@ -= Installation - -== Requirements - -This controller is deployed with https://github.com/vshn/component-appcat[component-appcat]. - -== Sources - -The data is matched from the local k8s cluster and the associated Exoscale organization. -The Kubernetes Service Account token is required to have `get` permissions on `Namespaces` and to the following managed resources: - -* `buckets.exoscale.crossplane.io` -* `postgresqls.exoscale.crossplane.io` -* `mysqls.exoscale.crossplane.io` -* `redis.exoscale.crossplane.io` -* `kafkas.exoscale.crossplane.io` -* `opensearches.exoscale.crossplane.io` - -=== Exoscale organization -The Access Key (IAM Key) from an Exoscale organization is required to have read access across all managed resources (e.g. SOS buckets, Postgres, etc). diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc deleted file mode 100644 index af47c81..0000000 --- a/docs/modules/ROOT/pages/index.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= billing-collector-cloudservices - -Controller to sync usage data from the Exoscale and Cloudscale metrics APIs to Odoo16 - -Metrics are collected taking into account product (e.g. `object-storage-storage:exoscale`), source (e.g. `exoscale:namespace`), tenant (organization) and date time. - -On DBaaS, we also gather information by Plan. That can be seeing in the product. For example, in the case of a PostgreSQL database service, product may look like `appcat-exoscale-pg-hobbyist-2`. diff --git a/docs/modules/ROOT/partials/nav.adoc b/docs/modules/ROOT/partials/nav.adoc deleted file mode 100644 index 77aa0e8..0000000 --- a/docs/modules/ROOT/partials/nav.adoc +++ /dev/null @@ -1,4 +0,0 @@ -* xref:index.adoc[Home] -* xref:how-tos/installation.adoc[Installation] -* xref:how-tos/multi-instance.adoc[Multi Instance] -* xref:references/parameters.adoc[Parameters]