Skip to content

Commit a1b39d5

Browse files
committed
chore: changed format
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
1 parent bfaba51 commit a1b39d5

1 file changed

Lines changed: 33 additions & 40 deletions

File tree

templates/metadata.hcl.tmpl

Lines changed: 33 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,47 @@
11
# SPDX-FileCopyrightText: Copyright © contributors to CloudNativePG, established as CloudNativePG a Series of LF Projects, LLC.
22
# SPDX-License-Identifier: Apache-2.0
3-
#
4-
5-
# TODO: REMOVE ALL COMMENTS BELOW BEFORE FINALIZING
6-
# ############################################################
7-
# IMPORTANT: this file is a template. All comments (lines starting # with "#"
8-
# or block comments) MUST be removed from the final `metadata.hcl` file before
9-
# publishing or using it in production. The comments are only explanatory notes
10-
# for authors of the contribution and must not remain in the final
11-
# `metadata.hcl`.
12-
# ############################################################
13-
#
14-
# Field notes (keep here only while editing the template):
15-
#
16-
# - `image_name`: MUST be unique across the container registry because
17-
# it identifies the image (e.g. ghcr.io/cloudnative-pg/<image_name>).
18-
#
19-
# - `shared_preload_libraries`: list libraries to be added to
20-
# `shared_preload_libraries` in Postgres. Normally empty.
21-
# Example: ["pgaudit"].
22-
#
23-
# - `extension_control_path`: if EMPTY (`[]`), the operator follows the CNPG
24-
# convention and will add the image's `share` directory to
25-
# `extension_control_path`.
26-
# See: https://cloudnative-pg.io/docs/current/imagevolume_extensions#image-specifications
27-
#
28-
# - `dynamic_library_path`: if EMPTY (`[]`) the operator will add the image's
29-
# `lib` directory to `dynamic_library_path`.
30-
#
31-
# - `ld_library_path`: this SHOULD be defined when your extension needs
32-
# additional (usually system) libraries loaded into Postgres before startup. If
33-
# left EMPTY (`[]`) the operator will NOT alter `ld_library_path`. See the
34-
# `postgis` extension metadata for an example usage.
35-
#
36-
# - `auto_update_os_libs`: set to true to allow the maintenance tooling
37-
# to update OS libraries automatically; look at the `postgis` example.
38-
#
39-
# - `required_extensions`: must contain the name(s) of the sibling
40-
# folders in this repository that contain a required extension.
41-
#
42-
# ############################################################
433
metadata = {
444
name = "{{ .Name }}"
455
sql_name = "{{ .Name }}"
6+
7+
# TODO: Remove this comment block after customizing the file.
8+
# `image_name`: MUST be unique across the container registry because
9+
# it identifies the image (e.g. ghcr.io/cloudnative-pg/<image_name>)
4610
image_name = "{{ .Name }}"
11+
12+
# TODO: Remove this comment block after customizing the file.
13+
# `shared_preload_libraries`: list libraries to be added to
14+
# `shared_preload_libraries` in Postgres. Normally empty.
15+
# Example: ["pgaudit"].
4716
shared_preload_libraries = []
17+
18+
# TODO: Remove this comment block after customizing the file.
19+
# `extension_control_path`: if EMPTY (`[]`), the operator follows the CNPG
20+
# convention and will add the image's `share` directory to
21+
# `extension_control_path`.
22+
# See: https://cloudnative-pg.io/docs/current/imagevolume_extensions#image-specifications
4823
extension_control_path = []
24+
25+
# TODO: Remove this comment block after customizing the file.
26+
# `dynamic_library_path`: if EMPTY (`[]`) the operator will add the image's
27+
# `lib` directory to `dynamic_library_path`.
4928
dynamic_library_path = []
29+
30+
# TODO: Remove this comment block after customizing the file.
31+
# `ld_library_path`: this SHOULD be defined when your extension needs
32+
# additional (usually system) libraries loaded into Postgres before startup.
33+
# If left EMPTY (`[]`) the operator will NOT alter `ld_library_path`. See the
34+
# `postgis` extension metadata for an example usage.
5035
ld_library_path = []
36+
37+
# TODO: Remove this comment block after customizing the file.
38+
# `auto_update_os_libs`: set to true to allow the maintenance tooling
39+
# to update OS libraries automatically; look at the `postgis` example.
5140
auto_update_os_libs = false
41+
42+
# TODO: Remove this comment block after customizing the file.
43+
# `required_extensions`: must contain the name(s) of the sibling
44+
# folders in this repository that contain a required extension.
5245
required_extensions = []
5346

5447
versions = {

0 commit comments

Comments
 (0)