From 0005ea6c72eebe749622c49eff309cd6765b8720 Mon Sep 17 00:00:00 2001 From: Richard Case Date: Wed, 27 Sep 2023 16:06:38 +0200 Subject: [PATCH] feat: add annotations / questions for chart Add the annotations for the chart to give a better experience in the app catalog. Also, started to add questions to customize the install. Signed-off-by: Richard Case --- charts/rancher-turtles/Chart.yaml | 20 ++++++++++- charts/rancher-turtles/README.md | 5 +++ charts/rancher-turtles/app-readme.md | 5 +++ charts/rancher-turtles/questions.yml | 52 ++++++++++++++++++++++++++++ 4 files changed, 81 insertions(+), 1 deletion(-) create mode 100644 charts/rancher-turtles/README.md create mode 100644 charts/rancher-turtles/app-readme.md create mode 100644 charts/rancher-turtles/questions.yml diff --git a/charts/rancher-turtles/Chart.yaml b/charts/rancher-turtles/Chart.yaml index 95f34293..9117cac4 100644 --- a/charts/rancher-turtles/Chart.yaml +++ b/charts/rancher-turtles/Chart.yaml @@ -1,11 +1,29 @@ apiVersion: v2 name: rancher-turtles -description: Rancher Turtles type: application version: 0.0.0 appVersion: "0.0.0" +description: Rancher Turtles is a extension to Rancher that brings full Cluster API integration to Rancher. +home: https://github.com/rancher-sandbox/rancher-turtles/ +icon: https://raw.githubusercontent.com/rancher-sandbox/rancher-turtles/main/logos/capi.svg +keywords: +- rancher +- cluster-api +- capi +- provisioning dependencies: - name: cluster-api-operator version: v0.5.1 repository: https://kubernetes-sigs.github.io/cluster-api-operator condition: cluster-api-operator.enabled +annotations: + catalog.cattle.io/certified: rancher + catalog.cattle.io/display-name: Rancher Turtles - the Cluster API operator + catalog.cattle.io/kube-version: '>= 1.23.0-0' + catalog.cattle.io/namespace: rancher-turtles-system + catalog.cattle.io/os: linux + catalog.cattle.io/permits-os: linux + catalog.cattle.io/rancher-version: '>= 2.7.7-0' + catalog.cattle.io/release-name: rancher-turtles + catalog.cattle.io/scope: management + catalog.cattle.io/type: cluster-tool diff --git a/charts/rancher-turtles/README.md b/charts/rancher-turtles/README.md new file mode 100644 index 00000000..9c8d9273 --- /dev/null +++ b/charts/rancher-turtles/README.md @@ -0,0 +1,5 @@ +# Rancher Turtles Chart + +This chart installs the Rancher Turtles operator and optionally the Cluster API Operator using Helm. + +Chheckout the [documentation](https://docs.rancher-turtles.com) for further information. diff --git a/charts/rancher-turtles/app-readme.md b/charts/rancher-turtles/app-readme.md new file mode 100644 index 00000000..aeb148ac --- /dev/null +++ b/charts/rancher-turtles/app-readme.md @@ -0,0 +1,5 @@ +# Rancher Turtles - The Cluster API Extension for Rancher + +Rancher Turtles brings enhanced integration of Cluster API with Rancher. + +For more information, including a getting started guide, see the [official documentation](https://docs.rancher-turtles.com). diff --git a/charts/rancher-turtles/questions.yml b/charts/rancher-turtles/questions.yml new file mode 100644 index 00000000..9ee65c40 --- /dev/null +++ b/charts/rancher-turtles/questions.yml @@ -0,0 +1,52 @@ +namespace: rancher-turtles-system +questions: +- variable: rancherTurtles.features.default + default: "true" + description: "Enable extra features" + label: Enable extra features + type: boolean + show_subquestion_if: false + group: "Rancher Turtles Extra Features" + subquestions: + - variable: rancherTurtles.features.embedded-capi.disabled + default: true + description: "Specify that the Rancher embedded cluster api feature be disabled" + type: boolean + label: Disable Rancher Embedded CAPI + group: "Rancher Turtles Features Settings" + - variable: rancherTurtles.features.rancher-webhook.cleanup + default: true + description: "Specify that the Rancher embedded cluster api webhooks should be removed" + type: boolean + label: Cleanup Rancher Embedded CAPI Webhooks + group: "Rancher Turtles Features Settings" + - variable: rancherTurtles.features.rancher-webhook.kubectlImage + default: "rancher/kubectl" + description: "Specify the image to use when cleaning up the webhooks" + type: string + label: Cleanup Image + group: "Rancher Turtles Features Settings" + - variable: rancherTurtles.features.rancher-kubeconfigs.label + default: true + description: "Specify that the kubeconfigs generated by Rancher should be automatically patched to contain the CAPI expected labels" + type: boolean + label: Label Rancher Kubeconfigs + group: "Rancher Turtles Features Settings" +- variable: cluster-api-operator.enabled + default: "true" + description: "Flag to enable or disable installation of the Cluster API Operator. If you disable this then you will need to manage the CAPI controllers yourself." + label: "Enable Cluster API Operator" + type: boolean + group: "Cluster API Operator" + show_subquestion_if: true + subquestions: + - variable: cluster-api-operator.cert-manager.enabled + default: "false" + description: "Flag to enable or disable installation of cert-manager. If set to false then you will need to install cert-manager manually" + label: "Enable Cert Manager" + type: boolean + - variable: cluster-api-operator.cluster-api.version + default: "v1.4.6" + required: true + description: "Version of the core CAPI controllers to install." + label: "Version"