diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index 013bb23..77c61c6 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -7,11 +7,13 @@ name: 🏷️ Pull Request Labeler on: - pull_request_target +permissions: + contents: read + jobs: labeler: name: Labeler permissions: - contents: read pull-requests: write uses: voxpupuli/crafty/.github/workflows/labeler.yml@main with: diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml new file mode 100644 index 0000000..1417f99 --- /dev/null +++ b/.github/workflows/markdownlint.yml @@ -0,0 +1,20 @@ +--- +name: Markdown Lint + +on: + pull_request: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + +jobs: + markdown-lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + - uses: DavidAnson/markdownlint-cli2-action@v20 + with: + globs: '**/*.md' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e16f1b0..aefadfa 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -10,13 +10,11 @@ on: - '*' permissions: - contents: read # minimal required permissions to clone repo + contents: read jobs: release: name: Release - permissions: - contents: write uses: voxpupuli/crafty/.github/workflows/release.yml@main with: allowed_owner: openvoxproject diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..327f64a --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,12 @@ +--- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + +ignores: + - .github/** + - .idea/** + - .vendor/** + - .vscode/** + - CHANGELOG.md + - test/** + - vendor/** diff --git a/.markdownlint.yaml b/.markdownlint.yaml index ec1ac95..2747978 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,6 +1,14 @@ +--- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + default: true -MD033: + +line-length: + line_length: 210 + +no-inline-html: allowed_elements: - br -MD013: - line_length: 210 + +descriptive-link-text: false diff --git a/README.md b/README.md index f883be0..ae37810 100644 --- a/README.md +++ b/README.md @@ -94,13 +94,13 @@ The following environment variables are supported: | Name | Usage / Default | |---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| | __AUTOSIGN__ | Whether or not to enable autosigning on the openvoxserver instance. Valid values are `true`, `false`, and `/path/to/autosign.conf`.

Defaults to `true`. | -| __CA_ALLOW_SUBJECT_ALT_NAMES__ | Whether or not SSL certificates containing Subject Alternative Names should be signed by the CA. Does nothing unless `CA_ENABLED=true`.

Defaults to `false` | +| __CA_ALLOW_SUBJECT_ALT_NAMES__ | Whether or not SSL certificates containing Subject Alternative Names should be signed by the CA. Does nothing unless `CA_ENABLED=true`.

Defaults to `false` | | __CA_ENABLED__ | Whether or not this openvoxserver instance has a running CA (Certificate Authority)

Defaults to `true` | | __CA_HOSTNAME__ | The DNS hostname for the openvoxserver running the CA. Does nothing unless `CA_ENABLED=false`

Defaults to `puppet` | | __CA_PORT__ | The listening port of the CA. Does nothing unless `CA_ENABLED=false`

Defaults to `8140` | | __CA_TTL__ | CA expire date (in seconds or with suffix `s`, `m`, `h`, `d`, `y`)

Defaults to `157680000` | | __CERTNAME__ | The DNS name used on the servers SSL certificate - sets the `certname` in puppet.conf

Defaults to unset. | -| __CSR_ATTRIBUTES__ | Provide a JSON string of the csr_attributes.yaml content. e.g. `CSR_ATTRIBUTES='{"custom_attributes": { "challengePassword": "foobar" }, "extension_requests": { "pp_project": "foo" } }'`

Defaults to empty JSON object `{}`
Please note that within a compose file, you must provide all environment variables as Hash and not as Array!
environment:
`CSR_ATTRIBUTES: '{"extension_request": {...}}'` | +| __CSR_ATTRIBUTES__ | Provide a JSON string of the csr_attributes.yaml content. e.g. `CSR_ATTRIBUTES='{"custom_attributes": { "challengePassword": "foobar" }, "extension_requests": { "pp_project": "foo" } }'`

Defaults to empty JSON object `{}`
Please note that within a compose file, you must provide all environment variables as Hash and not as Array!
environment:
`CSR_ATTRIBUTES: '{"extension_request": {...}}'` | | __DNS_ALT_NAMES__ | Additional DNS names to add to the servers SSL certificate
__Note__ only effective on initial run when certificates are generated | | __ENVIRONMENTPATH__ | Set an environmentpath

Defaults to `/etc/puppetlabs/code/environments` | | __HIERACONFIG__ | Set a hiera_config entry in puppet.conf file

Defaults to `$confdir/hiera.yaml` | @@ -111,18 +111,18 @@ The following environment variables are supported: | __OPENVOX_REPORTS__ | Sets `reports` in puppet.conf

Defaults to `puppetdb` | | __OPENVOX_STORECONFIGS__ | Sets `storeconfigs` in puppet.conf

Defaults to `true` | | __OPENVOX_STORECONFIGS_BACKEND__ | Sets `storeconfigs_backend` in puppet.conf

Defaults to `puppetdb` | -| __OPENVOXDB_SERVER_URLS__ | The URL of the OpenVoxDB servers. This is used to connect to the OpenVoxDB server.

Defaults to `https://openvoxdb:8081`
Please note that within a compose file, you must provide all environment variables as Hash and not as Array!
environment:
`OPENVOXDB_SERVER_URLS: 'https://openvoxdb:8081'` | +| __OPENVOXDB_SERVER_URLS__ | The URL of the OpenVoxDB servers. This is used to connect to the OpenVoxDB server.

Defaults to `https://openvoxdb:8081`
Please note that within a compose file, you must provide all environment variables as Hash and not as Array!
environment:
`OPENVOXDB_SERVER_URLS: 'https://openvoxdb:8081'` | | __OPENVOXSERVER_ENABLE_ENV_CACHE_DEL_API__ | Enable the puppet admin api endpoint via certificates to allow clearing environment caches

Defaults to `true` | | __OPENVOXSERVER_ENVIRONMENT_TIMEOUT__ | Configure the environment timeout

Defaults to `unlimited` | | __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ | Activate the graphite exporter. Also needs __OPENVOXSERVER_GRAPHITE_HOST__ and __OPENVOXSERVER_GRAPHITE_PORT__

Defaults to `false` | -| __OPENVOXSERVER_GRAPHITE_HOST__ | Only used if __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ is set to `true`. FQDN or Hostname of the graphite server where puppet should push metrics to.

Defaults to `exporter` | -| __OPENVOXSERVER_GRAPHITE_PORT__ | Only used if __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ is set to `true`. Port of the graphite server where puppet should push metrics to.

Default to `9109` | +| __OPENVOXSERVER_GRAPHITE_HOST__ | Only used if __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ is set to `true`. FQDN or Hostname of the graphite server where puppet should push metrics to.

Defaults to `exporter` | +| __OPENVOXSERVER_GRAPHITE_PORT__ | Only used if __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ is set to `true`. Port of the graphite server where puppet should push metrics to.

Default to `9109` | | __OPENVOXSERVER_HOSTNAME__ | The DNS name used on the servers SSL certificate - sets the `server` in puppet.conf

Defaults to unset. | | __OPENVOXSERVER_JAVA_ARGS__ | Arguments passed directly to the JVM when starting the service

Defaults to `-Xms1024m -Xmx1024m` | | __OPENVOXSERVER_MAX_ACTIVE_INSTANCES__ | The maximum number of JRuby instances allowed

Defaults to `1` | | __OPENVOXSERVER_MAX_REQUESTS_PER_INSTANCE__ | The maximum HTTP requests a JRuby instance will handle in its lifetime (disable instance flushing)

Defaults to `0` | | __OPENVOXSERVER_PORT__ | The port of the openvoxserver

Defaults to `8140` | -| __USE_OPENVOXDB__ | Whether to connect to puppetdb
Sets `OPENVOX_REPORTS` to `log` and `OPENVOX_STORECONFIGS` to `false` if `OPENVOX_STORECONFIGS_BACKEND` is `puppetdb`.

Defaults to `true`| +| __USE_OPENVOXDB__ | Whether to connect to puppetdb
Sets `OPENVOX_REPORTS` to `log` and `OPENVOX_STORECONFIGS` to `false` if `OPENVOX_STORECONFIGS_BACKEND` is `puppetdb`.

Defaults to `true`| ## Initialization Scripts diff --git a/RELEASE.md b/RELEASE.md index 62858c5..c9daceb 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,3 +1,5 @@ + + # Release ## On a fork diff --git a/renovate.json b/renovate.json index 37b584d..186a559 100644 --- a/renovate.json +++ b/renovate.json @@ -7,23 +7,23 @@ { "customType": "regex", "datasourceTemplate": "rubygems", - "fileMatch": [ - "build_versions.yaml" + "managerFilePatterns": [ + "/build_versions.yaml/" ], "matchStrings": [ - "rubygem_(?[a-z0-9_]+):\\s+'(?\\d+\\.\\d+\\.\\d+)'" + "rubygem_(?[a-z0-9_-]+):\\s+'(?\\d+\\.\\d+\\.\\d+)'" ] }, { "customType": "regex", "datasourceTemplate": "deb", - "fileMatch": [ - "build_versions.yaml" + "managerFilePatterns": [ + "/build_versions.yaml/" ], "matchStrings": [ "#\\s*renovate:\\s*depName=(?.*?)\\s*openVoxRelease=(?\\d+)\\s*\\n\\s*(?\\w+_version):\\s*\"(?.*?)\"" ], - "registryUrlTemplate": "https://apt.overlookinfratech.com?suite=ubuntu24.04&components=openvox{{openVoxRelease}}&binaryArch=amd64" + "registryUrlTemplate": "https://apt.voxpupuli.org?suite=ubuntu24.04&components=openvox{{openVoxRelease}}&binaryArch=amd64" } ], "extends": [ @@ -31,8 +31,7 @@ ], "addLabels": [ "dependencies", - "renovate", - "github_actions" + "renovate" ], "vulnerabilityAlerts": { "enabled": true,