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   vca_port:
  27     type: int
  28     description: "The VCA port."
  29   vca_user:
  30     type: string
  31     description: "The VCA user name."
  32   vca_secret:
  33     type: string
  34     description: "The VCA user secret."
  35   vca_pubkey:
  36     type: string
  37     description: "The VCA public key."
  38   vca_cacert:
  39     type: string
  40     description: "The VCA cacert."
  41   vca_apiproxy:
  42     type: string
  43     description: "The VCA api proxy (native charms)"
  44   vca_cloud:
  45     type: string
  46     description: "The VCA lxd cloud name"
  47   vca_k8s_cloud:
  48     type: string
  49     description: "The VCA K8s cloud name"
  50   database_commonkey:
  51     description: Database common key
  52     type: string
  53     default: osm
  54   mongodb_uri:
  55     type: string
  56     description: MongoDB URI (external database)
  57   log_level:
  58     description: "Log Level"
  59     type: string
  60     default: "INFO"
  61   vca_model_config_agent_metadata_url:
  62     description: The URL of the private stream.
  63     type: string
  64   vca_model_config_agent_stream:
  65     description: |
  66       The stream to use for deploy/upgrades of agents.
  67       See additional info below.
  68     type: string
  69   vca_model_config_apt_ftp_proxy:
  70     description: The APT FTP proxy for the model.
  71     type: string
  72   vca_model_config_apt_http_proxy:
  73     description: The APT HTTP proxy for the model.
  74     type: string
  75   vca_model_config_apt_https_proxy:
  76     description: The APT HTTPS proxy for the model.
  77     type: string
  78   vca_model_config_apt_mirror:
  79     description: The APT mirror for the model.
  80     type: string
  81   vca_model_config_apt_no_proxy:
  82     description: The APT no proxy for the model.
  83     type: string
  84   vca_model_config_automatically_retry_hooks:
  85     description: Set the policy on retying failed hooks.
  86     type: boolean
  87   vca_model_config_backup_dir:
  88     description: Backup directory
  89     type: string
  90   vca_model_config_cloudinit_userdata:
  91     description: Cloudinit userdata
  92     type: string
  93   vca_model_config_container_image_metadata_url:
  94     description: |
  95       Corresponds to 'image-metadata-url' (see below) for cloud-hosted
  96       KVM guests or LXD containers. Not needed for the localhost cloud.
  97     type: string
  98   vca_model_config_container_image_stream:
  99     description: |
 100       Corresponds to 'image-stream' (see below) for cloud-hosted KVM
 101       guests or LXD containers. Not needed for the localhost cloud.
 102     type: string
 103   vca_model_config_container_inherit_properties:
 104     description: |
 105       Set parameters to be inherited from a machine toits hosted
 106       containers (KVM or LXD).
 107     type: string
 108   vca_model_config_container_networking_method:
 109     description: |
 110       The FAN networking mode to use. Default values can be provider-specific.
 111     type: string
 112   vca_model_config_default_series:
 113     description: The default series of Ubuntu to use for deploying charms.
 114     type: string
 115   vca_model_config_default_space:
 116     description: |
 117       The space used as the default binding when deploying charms.
 118       Will be "alpha" by default.
 119     type: string
 120   vca_model_config_development:
 121     description: Set whether the model is in development mode.
 122     type: boolean
 123   vca_model_config_disable_network_management:
 124     description: |
 125       Set whether to give network control to the provider instead
 126       of Juju controlling configuration.
 127     type: boolean
 128   vca_model_config_egress_subnets:
 129     description: Egress subnets
 130     type: string
 131   vca_model_config_enable_os_refresh_update:
 132     description: |
 133       Set whether newly provisioned instances should run their
 134       respective OS's update capability.
 135     type: boolean
 136   vca_model_config_enable_os_upgrade:
 137     description: |
 138       Set whether newly provisioned instances should run their
 139       respective OS's upgrade capability.
 140     type: boolean
 141   vca_model_config_fan_config:
 142     description: |
 143       The FAN overlay and underlay networks in
 144       CIDR notation (space-separated).
 145     type: string
 146   vca_model_config_firewall_mode:
 147     description: The mode to use for network firewalling.
 148     type: string
 149   vca_model_config_ftp_proxy:
 150     description: |
 151       The FTP proxy value to configure on instances,
 152       in the FTP_PROXY environment variable.
 153     type: string
 154   vca_model_config_http_proxy:
 155     description: |
 156       The HTTP proxy value to configure on instances,
 157       in the HTTP_PROXY environment variable.
 158     type: string
 159   vca_model_config_https_proxy:
 160     description: |
 161       The HTTPS proxy value to configure on instances,
 162       in the HTTPS_PROXY environment variable.
 163     type: string
 164   vca_model_config_ignore_machine_addresses:
 165     description: |
 166       When true, the machine worker will not look up
 167       or discover any machine addresses.
 168     type: boolean
 169   vca_model_config_image_metadata_url:
 170     description: |
 171       The URL at which the metadata used to locate
 172       OS image ids is located.
 173     type: string
 174   vca_model_config_image_stream:
 175     description: |
 176       The simplestreams stream used to identify which image
 177       ids to search when starting an instance.
 178     type: string
 179   vca_model_config_juju_ftp_proxy:
 180     description: The charm-centric FTP proxy value.
 181     type: string
 182   vca_model_config_juju_http_proxy:
 183     description: The charm-centric HTTP proxy value.
 184     type: string
 185   vca_model_config_juju_https_proxy:
 186     description: The charm-centric HTTPS proxy value.
 187     type: string
 188   vca_model_config_juju_no_proxy:
 189     description: The charm-centric no-proxy value.
 190     type: string
 191   vca_model_config_logforward_enabled:
 192     description: Set whether the log forward function is enabled.
 193     type: boolean
 194   vca_model_config_logging_config:
 195     description: |
 196       The configuration string to use when configuring Juju agent logging
 197     type: string
 198   vca_model_config_lxd_snap_channel:
 199     description: LXD snap channel
 200     type: string
 201   vca_model_config_max_action_results_age:
 202     description: The maximum aget for status action results entries
 203     type: string
 204   vca_model_config_max_action_results_size:
 205     description: The maximum size for status action results entries
 206     type: string
 207   vca_model_config_max_status_history_age:
 208     description: |
 209       The maximum age for status history entries before they are pruned,
 210       in a human-readable time format.
 211     type: string
 212   vca_model_config_max_status_history_size:
 213     description: |
 214       The maximum size for the status history collection,
 215       in human-readable memory format.
 216     type: string
 217   vca_model_config_net_bond_reconfigure_delay:
 218     description: Net bond reconfigure delay
 219     type: int
 220   vca_model_config_no_proxy:
 221     description: List of domain addresses not to be proxied (comma-separated).
 222     type: string
 223   vca_model_config_provisioner_harvest_mode:
 224     description: Set what to do with unknown machines.
 225     type: string
 226   vca_model_config_proxy_ssh:
 227     description: |
 228       Set whether SSH commands should be proxied through the API server.
 229     type: boolean
 230   vca_model_config_snap_http_proxy:
 231     description: The snap-centric HTTP proxy value.
 232     type: string
 233   vca_model_config_snap_https_proxy:
 234     description: The snap-centric HTTPS proxy value.
 235     type: string
 236   vca_model_config_snap_store_assertions:
 237     description: |
 238       The collection of snap store assertions.
 239       Each entry should contain the snap store ID.
 240     type: string
 241   vca_model_config_snap_store_proxy:
 242     description: The snap store ID.
 243     type: string
 244   vca_model_config_snap_store_proxy_url:
 245     description: The snap store proxy url
 246     type: string
 247   vca_model_config_ssl_hostname_verification:
 248     description: Set whether SSL hostname verification is enabled.
 249     type: boolean
 250   vca_model_config_test_mode:
 251     description: |
 252       Set whether the model is intended for testing.
 253       If true, accessing the charm store does not affect
 254       statistical data of the store.
 255     type: boolean
 256   vca_model_config_transmit_vendor_metrics:
 257     description: |
 258       Set whether the controller will send metrics collected from
 259       this model for use in anonymized aggregate analytics.
 260     type: boolean
 261   vca_model_config_update_status_hook_interval:
 262     description: |
 263       The run frequency of the update-status hook.
 264       The value has a random +/- 20% offset applied to avoid hooks
 265       for all units firing at once. Value change only honoured
 266       during controller and model creation
 267       (bootstrap --config and add-model --config).
 268     type: string
 269   vca_stablerepourl:
 270     description: Stable repository URL for Helm charts
 271     type: string
 272     default: https://charts.helm.sh/stable
 273   vca_helm_ca_certs:
 274     description: CA certificates to validate access to Helm repository
 275     type: string
 276     default: ""
 277   image_pull_policy:
 278     type: string
 279     description: |
 280       ImagePullPolicy configuration for the pod.
 281       Possible values: always, ifnotpresent, never
 282     default: always
 283   debug_mode:
 284     description: |
 285       If true, debug mode is activated. It means that the service will not run,
 286       and instead, the command for the container will be a `sleep infinity`.
 287       Note: If enabled, security_context will be disabled.
 288     type: boolean
 289     default: false
 290   debug_pubkey:
 291     description: |
 292       Public SSH key that will be injected to the application pod.
 293     type: string
 294   debug_lcm_local_path:
 295     description: |
 296       Local full path to the LCM project.
 297
 298       The path will be mounted to the docker image,
 299       which means changes during the debugging will be saved in your local path.
 300     type: string
 301   debug_n2vc_local_path:
 302     description: |
 303       Local full path to the N2VC project.
 304
 305       The path will be mounted to the docker image,
 306       which means changes during the debugging will be saved in your local path.
 307     type: string
 308   debug_common_local_path:
 309     description: |
 310       Local full path to the COMMON project.
 311
 312       The path will be mounted to the docker image,
 313       which means changes during the debugging will be saved in your local path.
 314     type: string
 315   security_context:
 316     description: Enables the security context of the pods
 317     type: boolean
 318     default: false