Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deckhouse/dmt
https://github.com/deckhouse/dmt
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/deckhouse/dmt
- Owner: deckhouse
- License: other
- Created: 2024-09-09T09:41:18.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-13T14:08:01.000Z (about 1 month ago)
- Last Synced: 2024-11-13T14:32:07.155Z (about 1 month ago)
- Language: Go
- Size: 316 KB
- Stars: 1
- Watchers: 22
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dmt
Deckhouse Module Tool - the swiss knife for your Deckhouse modules
### How to use
#### Lint
You can run linter checks for a module:
```shell
dmt lint /some/path/
```
or some pack of modules
```shell
dmt lint /some/path/
```
where `/some/path/` looks like this:
```shell
ls -l /some/path/
drwxrwxr-x 1 deckhouse deckhouse 4096 Nov 10 21:46 001-module-one
drwxrwxr-x 1 deckhouse deckhouse 4096 Nov 12 21:45 002-module-two
drwxrwxr-x 1 deckhouse deckhouse 4096 Nov 10 21:46 003-module-three
```
#### Gen
Generate some automatic rules for you module
## Configuration
You can exclude linters or setup them via the config file `.dmt-lint`
Example settings:
```yaml
linters-settings:
probes:
probes-excludes:
d8-istio:
- kube-rbac-proxy
- operator
openapi:
enum-file-excludes:
- prometheus:/openapi/values.yaml:
- "properties.internal.properties.grafana.properties.alertsChannelsConfig.properties.notifiers.items.properties.type"
nocyrillic:
no-cyrillic-file-excludes:
- user-authz:/rbac.yaml
- documentation:/images/web/site/_data/topnav.yml
license:
copyright-excludes:
- upmeter:/images/upmeter/stress.sh
- cni-simple-bridge:/images/simple-bridge/rootfs/bin/simple-bridge
skip-oss-checks:
- 001-priority-class
rbac:
skip-check-wildcards:
- "admission-policy-engine/templates/rbac-for-us.yaml":
- "d8:admission-policy-engine:gatekeeper"
skip-module-check-binding:
- "user-authz"
skip-object-check-binding:
- "user-authz"
- "deckhouse"
helm:
skip-module-image-name:
- "021-cni-cilium/images/cilium/Dockerfile"
- "021-cni-cilium/images/virt-cilium/Dockerfile"
skip-distroless-image-check:
- "base-cilium-dev/werf.inc.yaml"
- "cilium-envoy/werf.inc.yaml"
container:
skip-containers:
- "okmeter:okagent"
- "d8-control-plane-manager:*.image-holder"
monitoring:
skip-module-checks:
- "340-extended-monitoring"
- "030-cloud-provider-yandex"
warnings-only:
- openapi
- no-cyrillic
- copyright
- probes
```