Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 add parameters reference #27

Merged
merged 1 commit into from
Aug 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,21 @@ provider:
helm install external-dns external-dns -f external-dns-midaas-values.yaml
```

## Parameters references

| Name | Description | Default value |
| ------------------------ | ----------------------------------------------------- | ---------------------------------- |
| API_SERVER_PORT | define the host where api listen, for all interfaces | `"0.0.0.0"` |
| API_SERVER_HOST | define the port where api listen | `"8888"` |
| API_READ_TIMEOUT | timout until read | `3s` |
| API_WRITE_TIMEOUT | timeout until write | `3s` |
| API_LOG_LEVEL | log level among `DEBUG`,`INFO`,`TRACE`,`WARN`,`ERROR` | `INFO` |
| PROVIDER_SKIP_TLS_VERIFY | enable tls verification | `false` |
| PROVIDER_DNS_ZONE_SUFFIX | dns zone suffix | `"dev.example.com"` |
| PROVIDER_WS_URL | webservice url | `"https://webservice.example.com"` |



## Local development

🚧 Work in progress.
Expand Down