Configuration¶

Configuration files are strictly decoded and validated for the command in use.

Prefer ${ENV} references for secrets; plaintext secret values produce a warning.

Priority¶

CLI Flags > YAML > Environment Variables > Defaults

Example Configurations¶

Artifactory (generate):

# yaml-language-server: $schema=https://raw.githubusercontent.com/tenthirtyam/artifactory-content-library/main/schema/config.schema.json
---
libraries:
  - name: example
    type: artifactory
    path: path/to/content
    artifactory:
      url: https://packages.example.com/artifactory
      repo: example
      ssl_verify: true
      rate_limit: 10
      timeout_seconds: 30
      max_retries: 3
      auth:
        # Use Basic Authentication:
        # username: ${ARTIFACTORY_USERNAME}
        # password: ${ARTIFACTORY_PASSWORD}
        # Or Use API Key:
        # api_key: ${ARTIFACTORY_API_KEY}
        # Or Use Access Token:
        # token: ${ARTIFACTORY_TOKEN}

logging:
  format: standard
  level: info

Subscribe (subscribe):

# yaml-language-server: $schema=https://raw.githubusercontent.com/tenthirtyam/artifactory-content-library/main/schema/config.schema.json
---
vsphere:
  url: ${VSPHERE_URL}
  username: ${VSPHERE_USERNAME}
  password: ${VSPHERE_PASSWORD}
  ssl_verify: true

library:
  name: Artifactory Subscribed Library
  datacenter: dc01
  datastore: ds01
  auto_sync: true
  on_demand: false
  publisher_subscription_url: https://packages.example.com/artifactory/.../lib.json
  publisher_ssl_thumbprint: ""
  publisher_username: ${VSPHERE_PUBLISHER_USERNAME}
  publisher_password: ${VSPHERE_PUBLISHER_PASSWORD}

logging:
  format: standard
  level: info

Schema¶

A JSON Schema for configuration files is published with the project at schema/config.schema.json.

Reference¶

See Reference for global options, command flags, and environment variables.