6301622e064e63346413962e2bdc61c4115bf8f6
[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   log_level:
63     description: "Log Level"
64     type: string
65     default: "INFO"
66   vca_model_config_agent_metadata_url:
67     description: The URL of the private stream.
68     type: string
69   vca_model_config_agent_stream:
70     description: |
71       The stream to use for deploy/upgrades of agents.
72       See additional info below.
73     type: string
74   vca_model_config_apt_ftp_proxy:
75     description: The APT FTP proxy for the model.
76     type: string
77   vca_model_config_apt_http_proxy:
78     description: The APT HTTP proxy for the model.
79     type: string
80   vca_model_config_apt_https_proxy:
81     description: The APT HTTPS proxy for the model.
82     type: string
83   vca_model_config_apt_mirror:
84     description: The APT mirror for the model.
85     type: string
86   vca_model_config_apt_no_proxy:
87     description: The APT no proxy for the model.
88     type: string
89   vca_model_config_automatically_retry_hooks:
90     description: Set the policy on retying failed hooks.
91     type: boolean
92   vca_model_config_backup_dir:
93     description: Backup directory
94     type: string
95   vca_model_config_cloudinit_userdata:
96     description: Cloudinit userdata
97     type: string
98   vca_model_config_container_image_metadata_url:
99     description: |
100       Corresponds to 'image-metadata-url' (see below) for cloud-hosted
101       KVM guests or LXD containers. Not needed for the localhost cloud.
102     type: string
103   vca_model_config_container_image_stream:
104     description: |
105       Corresponds to 'image-stream' (see below) for cloud-hosted KVM
106       guests or LXD containers. Not needed for the localhost cloud.
107     type: string
108   vca_model_config_container_inherit_properties:
109     description: |
110       Set parameters to be inherited from a machine toits hosted
111       containers (KVM or LXD).
112     type: string
113   vca_model_config_container_networking_method:
114     description: |
115       The FAN networking mode to use. Default values can be provider-specific.
116     type: string
117   vca_model_config_default_series:
118     description: The default series of Ubuntu to use for deploying charms.
119     type: string
120   vca_model_config_default_space:
121     description: |
122       The space used as the default binding when deploying charms.
123       Will be "alpha" by default.
124     type: string
125   vca_model_config_development:
126     description: Set whether the model is in development mode.
127     type: boolean
128   vca_model_config_disable_network_management:
129     description: |
130       Set whether to give network control to the provider instead
131       of Juju controlling configuration.
132     type: boolean
133   vca_model_config_egress_subnets:
134     description: Egress subnets
135     type: string
136   vca_model_config_enable_os_refresh_update:
137     description: |
138       Set whether newly provisioned instances should run their
139       respective OS's update capability.
140     type: boolean
141   vca_model_config_enable_os_upgrade:
142     description: |
143       Set whether newly provisioned instances should run their
144       respective OS's upgrade capability.
145     type: boolean
146   vca_model_config_fan_config:
147     description: |
148       The FAN overlay and underlay networks in
149       CIDR notation (space-separated).
150     type: string
151   vca_model_config_firewall_mode:
152     description: The mode to use for network firewalling.
153     type: string
154   vca_model_config_ftp_proxy:
155     description: |
156       The FTP proxy value to configure on instances,
157       in the FTP_PROXY environment variable.
158     type: string
159   vca_model_config_http_proxy:
160     description: |
161       The HTTP proxy value to configure on instances,
162       in the HTTP_PROXY environment variable.
163     type: string
164   vca_model_config_https_proxy:
165     description: |
166       The HTTPS proxy value to configure on instances,
167       in the HTTPS_PROXY environment variable.
168     type: string
169   vca_model_config_ignore_machine_addresses:
170     description: |
171       When true, the machine worker will not look up
172       or discover any machine addresses.
173     type: boolean
174   vca_model_config_image_metadata_url:
175     description: |
176       The URL at which the metadata used to locate
177       OS image ids is located.
178     type: string
179   vca_model_config_image_stream:
180     description: |
181       The simplestreams stream used to identify which image
182       ids to search when starting an instance.
183     type: string
184   vca_model_config_juju_ftp_proxy:
185     description: The charm-centric FTP proxy value.
186     type: string
187   vca_model_config_juju_http_proxy:
188     description: The charm-centric HTTP proxy value.
189     type: string
190   vca_model_config_juju_https_proxy:
191     description: The charm-centric HTTPS proxy value.
192     type: string
193   vca_model_config_juju_no_proxy:
194     description: The charm-centric no-proxy value.
195     type: string
196   vca_model_config_logforward_enabled:
197     description: Set whether the log forward function is enabled.
198     type: boolean
199   vca_model_config_logging_config:
200     description: |
201       The configuration string to use when configuring Juju agent logging
202     type: string
203   vca_model_config_lxd_snap_channel:
204     description: LXD snap channel
205     type: string
206   vca_model_config_max_action_results_age:
207     description: The maximum aget for status action results entries
208     type: string
209   vca_model_config_max_action_results_size:
210     description: The maximum size for status action results entries
211     type: string
212   vca_model_config_max_status_history_age:
213     description: |
214       The maximum age for status history entries before they are pruned,
215       in a human-readable time format.
216     type: string
217   vca_model_config_max_status_history_size:
218     description: |
219       The maximum size for the status history collection,
220       in human-readable memory format.
221     type: string
222   vca_model_config_net_bond_reconfigure_delay:
223     description: Net bond reconfigure delay
224     type: int
225   vca_model_config_no_proxy:
226     description: List of domain addresses not to be proxied (comma-separated).
227     type: string
228   vca_model_config_provisioner_harvest_mode:
229     description: Set what to do with unknown machines.
230     type: string
231   vca_model_config_proxy_ssh:
232     description: |
233       Set whether SSH commands should be proxied through the API server.
234     type: boolean
235   vca_model_config_snap_http_proxy:
236     description: The snap-centric HTTP proxy value.
237     type: string
238   vca_model_config_snap_https_proxy:
239     description: The snap-centric HTTPS proxy value.
240     type: string
241   vca_model_config_snap_store_assertions:
242     description: |
243       The collection of snap store assertions.
244       Each entry should contain the snap store ID.
245     type: string
246   vca_model_config_snap_store_proxy:
247     description: The snap store ID.
248     type: string
249   vca_model_config_snap_store_proxy_url:
250     description: The snap store proxy url
251     type: string
252   vca_model_config_ssl_hostname_verification:
253     description: Set whether SSL hostname verification is enabled.
254     type: boolean
255   vca_model_config_test_mode:
256     description: |
257       Set whether the model is intended for testing.
258       If true, accessing the charm store does not affect
259       statistical data of the store.
260     type: boolean
261   vca_model_config_transmit_vendor_metrics:
262     description: |
263       Set whether the controller will send metrics collected from
264       this model for use in anonymized aggregate analytics.
265     type: boolean
266   vca_model_config_update_status_hook_interval:
267     description: |
268       The run frequency of the update-status hook.
269       The value has a random +/- 20% offset applied to avoid hooks
270       for all units firing at once. Value change only honoured
271       during controller and model creation
272       (bootstrap --config and add-model --config).
273     type: string