Adding manual external DB URI config
[osm/devops.git] / installers / charm / lcm / config.yaml
1 # Copyright 2020 Canonical Ltd.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License"); you may
4 # not use this file except in compliance with the License. You may obtain
5 # a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 # License for the specific language governing permissions and limitations
13 # under the License.
14 #
15 # For those usages not covered by the Apache License, Version 2.0 please
16 # contact: legal@canonical.com
17 #
18 # To get in touch with the maintainers, please contact:
19 # osm-charmers@lists.launchpad.net
20 ##
21
22 options:
23   vca_host:
24     type: string
25     description: "The VCA host."
26     default: "admin"
27   vca_port:
28     type: int
29     description: "The VCA port."
30     default: 17070
31   vca_user:
32     type: string
33     description: "The VCA user name."
34     default: "admin"
35   vca_secret:
36     type: string
37     description: "The VCA user secret."
38     default: "secret"
39   vca_pubkey:
40     type: string
41     description: "The VCA public key."
42     default: "secret"
43   vca_cacert:
44     type: string
45     description: "The VCA cacert."
46   vca_apiproxy:
47     type: string
48     description: "The VCA api proxy (native charms)"
49     default: ""
50   vca_cloud:
51     type: string
52     description: "The VCA lxd cloud name"
53     default: "localhost"
54   vca_k8s_cloud:
55     type: string
56     description: "The VCA K8s cloud name"
57     default: "k8scloud"
58   database_commonkey:
59     description: Database common key
60     type: string
61     default: osm
62   mongodb_uri:
63     type: string
64     description: MongoDB URI (external database)
65   log_level:
66     description: "Log Level"
67     type: string
68     default: "INFO"
69   vca_model_config_agent_metadata_url:
70     description: The URL of the private stream.
71     type: string
72   vca_model_config_agent_stream:
73     description: |
74       The stream to use for deploy/upgrades of agents.
75       See additional info below.
76     type: string
77   vca_model_config_apt_ftp_proxy:
78     description: The APT FTP proxy for the model.
79     type: string
80   vca_model_config_apt_http_proxy:
81     description: The APT HTTP proxy for the model.
82     type: string
83   vca_model_config_apt_https_proxy:
84     description: The APT HTTPS proxy for the model.
85     type: string
86   vca_model_config_apt_mirror:
87     description: The APT mirror for the model.
88     type: string
89   vca_model_config_apt_no_proxy:
90     description: The APT no proxy for the model.
91     type: string
92   vca_model_config_automatically_retry_hooks:
93     description: Set the policy on retying failed hooks.
94     type: boolean
95   vca_model_config_backup_dir:
96     description: Backup directory
97     type: string
98   vca_model_config_cloudinit_userdata:
99     description: Cloudinit userdata
100     type: string
101   vca_model_config_container_image_metadata_url:
102     description: |
103       Corresponds to 'image-metadata-url' (see below) for cloud-hosted
104       KVM guests or LXD containers. Not needed for the localhost cloud.
105     type: string
106   vca_model_config_container_image_stream:
107     description: |
108       Corresponds to 'image-stream' (see below) for cloud-hosted KVM
109       guests or LXD containers. Not needed for the localhost cloud.
110     type: string
111   vca_model_config_container_inherit_properties:
112     description: |
113       Set parameters to be inherited from a machine toits hosted
114       containers (KVM or LXD).
115     type: string
116   vca_model_config_container_networking_method:
117     description: |
118       The FAN networking mode to use. Default values can be provider-specific.
119     type: string
120   vca_model_config_default_series:
121     description: The default series of Ubuntu to use for deploying charms.
122     type: string
123   vca_model_config_default_space:
124     description: |
125       The space used as the default binding when deploying charms.
126       Will be "alpha" by default.
127     type: string
128   vca_model_config_development:
129     description: Set whether the model is in development mode.
130     type: boolean
131   vca_model_config_disable_network_management:
132     description: |
133       Set whether to give network control to the provider instead
134       of Juju controlling configuration.
135     type: boolean
136   vca_model_config_egress_subnets:
137     description: Egress subnets
138     type: string
139   vca_model_config_enable_os_refresh_update:
140     description: |
141       Set whether newly provisioned instances should run their
142       respective OS's update capability.
143     type: boolean
144   vca_model_config_enable_os_upgrade:
145     description: |
146       Set whether newly provisioned instances should run their
147       respective OS's upgrade capability.
148     type: boolean
149   vca_model_config_fan_config:
150     description: |
151       The FAN overlay and underlay networks in
152       CIDR notation (space-separated).
153     type: string
154   vca_model_config_firewall_mode:
155     description: The mode to use for network firewalling.
156     type: string
157   vca_model_config_ftp_proxy:
158     description: |
159       The FTP proxy value to configure on instances,
160       in the FTP_PROXY environment variable.
161     type: string
162   vca_model_config_http_proxy:
163     description: |
164       The HTTP proxy value to configure on instances,
165       in the HTTP_PROXY environment variable.
166     type: string
167   vca_model_config_https_proxy:
168     description: |
169       The HTTPS proxy value to configure on instances,
170       in the HTTPS_PROXY environment variable.
171     type: string
172   vca_model_config_ignore_machine_addresses:
173     description: |
174       When true, the machine worker will not look up
175       or discover any machine addresses.
176     type: boolean
177   vca_model_config_image_metadata_url:
178     description: |
179       The URL at which the metadata used to locate
180       OS image ids is located.
181     type: string
182   vca_model_config_image_stream:
183     description: |
184       The simplestreams stream used to identify which image
185       ids to search when starting an instance.
186     type: string
187   vca_model_config_juju_ftp_proxy:
188     description: The charm-centric FTP proxy value.
189     type: string
190   vca_model_config_juju_http_proxy:
191     description: The charm-centric HTTP proxy value.
192     type: string
193   vca_model_config_juju_https_proxy:
194     description: The charm-centric HTTPS proxy value.
195     type: string
196   vca_model_config_juju_no_proxy:
197     description: The charm-centric no-proxy value.
198     type: string
199   vca_model_config_logforward_enabled:
200     description: Set whether the log forward function is enabled.
201     type: boolean
202   vca_model_config_logging_config:
203     description: |
204       The configuration string to use when configuring Juju agent logging
205     type: string
206   vca_model_config_lxd_snap_channel:
207     description: LXD snap channel
208     type: string
209   vca_model_config_max_action_results_age:
210     description: The maximum aget for status action results entries
211     type: string
212   vca_model_config_max_action_results_size:
213     description: The maximum size for status action results entries
214     type: string
215   vca_model_config_max_status_history_age:
216     description: |
217       The maximum age for status history entries before they are pruned,
218       in a human-readable time format.
219     type: string
220   vca_model_config_max_status_history_size:
221     description: |
222       The maximum size for the status history collection,
223       in human-readable memory format.
224     type: string
225   vca_model_config_net_bond_reconfigure_delay:
226     description: Net bond reconfigure delay
227     type: int
228   vca_model_config_no_proxy:
229     description: List of domain addresses not to be proxied (comma-separated).
230     type: string
231   vca_model_config_provisioner_harvest_mode:
232     description: Set what to do with unknown machines.
233     type: string
234   vca_model_config_proxy_ssh:
235     description: |
236       Set whether SSH commands should be proxied through the API server.
237     type: boolean
238   vca_model_config_snap_http_proxy:
239     description: The snap-centric HTTP proxy value.
240     type: string
241   vca_model_config_snap_https_proxy:
242     description: The snap-centric HTTPS proxy value.
243     type: string
244   vca_model_config_snap_store_assertions:
245     description: |
246       The collection of snap store assertions.
247       Each entry should contain the snap store ID.
248     type: string
249   vca_model_config_snap_store_proxy:
250     description: The snap store ID.
251     type: string
252   vca_model_config_snap_store_proxy_url:
253     description: The snap store proxy url
254     type: string
255   vca_model_config_ssl_hostname_verification:
256     description: Set whether SSL hostname verification is enabled.
257     type: boolean
258   vca_model_config_test_mode:
259     description: |
260       Set whether the model is intended for testing.
261       If true, accessing the charm store does not affect
262       statistical data of the store.
263     type: boolean
264   vca_model_config_transmit_vendor_metrics:
265     description: |
266       Set whether the controller will send metrics collected from
267       this model for use in anonymized aggregate analytics.
268     type: boolean
269   vca_model_config_update_status_hook_interval:
270     description: |
271       The run frequency of the update-status hook.
272       The value has a random +/- 20% offset applied to avoid hooks
273       for all units firing at once. Value change only honoured
274       during controller and model creation
275       (bootstrap --config and add-model --config).
276     type: string