Added documentation
Change-Id: I4cb4c8c56642337899d0865c147b54df72b2c1fa
diff --git a/roles/openstack_helm_nova/defaults/main.yml b/roles/openstack_helm_nova/defaults/main.yml
index 75ad162..f956af9 100644
--- a/roles/openstack_helm_nova/defaults/main.yml
+++ b/roles/openstack_helm_nova/defaults/main.yml
@@ -1,29 +1,79 @@
-# Copyright (c) 2022 VEXXHOST, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
+---
+# .. vim: foldmarker=[[[,]]]:foldmethod=marker
+# .. Copyright (C) 2022 VEXXHOST, Inc.
+# .. SPDX-License-Identifier: Apache-2.0
+
+# Default variables
+# =================
+
+# .. contents:: Sections
+# :local:
+
+
+# .. envvar:: openstack_helm_nova_chart_repo_name [[[
+#
+# Helm repository name for the chart.
openstack_helm_nova_chart_repo_name: openstack-helm
+
+ # ]]]
+# .. envvar:: openstack_helm_nova_chart_repo_url [[[
+#
+# Helm repository URL for the chart.
openstack_helm_nova_chart_repo_url: https://tarballs.opendev.org/openstack/openstack-helm/
+
+ # ]]]
+# .. envvar:: openstack_helm_nova_chart_name [[[
+#
+# Helm chart name (will also be used for release name)
openstack_helm_nova_chart_name: nova
+ # ]]]
+# .. envvar:: openstack_helm_nova_image_repository [[[
+#
+# Image repository location to be prefixed for all images
openstack_helm_nova_image_repository: "{{ atmosphere_image_repository | default('us-docker.pkg.dev/vexxhost-infra/openstack') }}"
+
+ # ]]]
+# .. envvar:: openstack_helm_nova_image_tag [[[
+#
+# Image tag for container
openstack_helm_nova_image_tag: 23.1.1.dev11
+
+ # ]]]
+# .. envvar:: openstack_helm_nova_ssh_image_tag [[[
+#
+# Image tag for SSH container
openstack_helm_nova_ssh_image_tag: wallaby
+
+ # ]]]
+# .. envvar:: openstack_helm_nova_heat_image_tag [[[
+#
+# Image tag for Heat to be used for jobs running via Helm hooks
openstack_helm_nova_heat_image_tag: wallaby
+ # ]]]
+# .. envvar:: openstack_helm_nova_diff [[[
+#
+# Disable a diff of the release values and ask for manual confirmation
openstack_helm_nova_diff: false
+
+ # ]]]
+# .. envvar:: openstack_helm_nova_migrate_from_mariadb [[[
+#
+# Execute a migration from legacy MariaDB to Percona XtraDB cluster
openstack_helm_nova_migrate_from_mariadb: false
+ # ]]]
+# .. envvar:: openstack_helm_nova_values [[[
+#
+# Overrides for Helm chart values
openstack_helm_nova_values: {}
+ # ]]]
+# .. envvar:: openstack_helm_nova_flavors [[[
+#
+# List of flavors to provision inside Nova
openstack_helm_nova_flavors: []
+
+ # ]]]