Skip to content

Commit 9fb4ce2

Browse files
mblaschkemblaschke
committed
update readme
Signed-off-by: Markus Blaschke <[email protected]>
1 parent b2e1340 commit 9fb4ce2

File tree

1 file changed

+20
-42
lines changed

1 file changed

+20
-42
lines changed

‎README.md

Lines changed: 20 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -21,43 +21,27 @@ Usage:
2121
kube-bootstrap-token-manager [OPTIONS]
2222
2323
Application Options:
24-
--debug debug mode [$DEBUG]
25-
--trace verbose mode [$TRACE]
24+
--log.debug debug mode [$LOG_DEBUG]
25+
--log.devel development mode [$LOG_DEVEL]
2626
--log.json Switch log output to json format [$LOG_JSON]
27-
--bootstraptoken.id-template= Template for token ID for bootstrap tokens (default: {{.Date}})
28-
[$BOOTSTRAPTOKEN_ID_TEMPLATE]
29-
--bootstraptoken.name= Name for bootstrap tokens (default: bootstrap-token-%s)
30-
[$BOOTSTRAPTOKEN_NAME]
31-
--bootstraptoken.label= Label for bootstrap tokens (default:
32-
webdevops.kubernetes.io/bootstraptoken-managed) [$BOOTSTRAPTOKEN_LABEL]
33-
--bootstraptoken.namespace= Namespace for bootstrap tokens (default: kube-system)
34-
[$BOOTSTRAPTOKEN_NAMESPACE]
35-
--bootstraptoken.type= Type for bootstrap tokens (default: bootstrap.kubernetes.io/token)
36-
[$BOOTSTRAPTOKEN_TYPE]
37-
--bootstraptoken.usage-bootstrap-authentication= Usage bootstrap authentication for bootstrap tokens (default: true)
38-
[$BOOTSTRAPTOKEN_USAGE_BOOTSTRAP_AUTHENTICATION]
39-
--bootstraptoken.usage-bootstrap-signing= usage bootstrap signing for bootstrap tokens (default: true)
40-
[$BOOTSTRAPTOKEN_USAGE_BOOTSTRAP_SIGNING]
41-
--bootstraptoken.auth-extra-groups= Auth extra groups for bootstrap tokens (default:
42-
system:bootstrappers:worker,system:bootstrappers:ingress)
43-
[$BOOTSTRAPTOKEN_AUTH_EXTRA_GROUPS]
44-
--bootstraptoken.expiration= Expiration (time.Duration) for bootstrap tokens (default: 8760h)
45-
[$BOOTSTRAPTOKEN_EXPIRATION]
46-
--bootstraptoken.token-length= Length of the random token string for bootstrap tokens (default: 16)
47-
[$BOOTSTRAPTOKEN_TOKEN_LENGTH]
48-
--bootstraptoken.token-runes= Runes which should be used for the random token string for bootstrap
49-
tokens (default: abcdefghijklmnopqrstuvwxyz0123456789)
27+
--bootstraptoken.id-template= Template for token ID for bootstrap tokens (default: {{.Date}}) [$BOOTSTRAPTOKEN_ID_TEMPLATE]
28+
--bootstraptoken.name= Name for bootstrap tokens (default: bootstrap-token-%s) [$BOOTSTRAPTOKEN_NAME]
29+
--bootstraptoken.label= Label for bootstrap tokens (default: webdevops.kubernetes.io/bootstraptoken-managed) [$BOOTSTRAPTOKEN_LABEL]
30+
--bootstraptoken.namespace= Namespace for bootstrap tokens (default: kube-system) [$BOOTSTRAPTOKEN_NAMESPACE]
31+
--bootstraptoken.type= Type for bootstrap tokens (default: bootstrap.kubernetes.io/token) [$BOOTSTRAPTOKEN_TYPE]
32+
--bootstraptoken.usage-bootstrap-authentication= Usage bootstrap authentication for bootstrap tokens (default: true) [$BOOTSTRAPTOKEN_USAGE_BOOTSTRAP_AUTHENTICATION]
33+
--bootstraptoken.usage-bootstrap-signing= usage bootstrap signing for bootstrap tokens (default: true) [$BOOTSTRAPTOKEN_USAGE_BOOTSTRAP_SIGNING]
34+
--bootstraptoken.auth-extra-groups= Auth extra groups for bootstrap tokens (default: system:bootstrappers:worker,system:bootstrappers:ingress) [$BOOTSTRAPTOKEN_AUTH_EXTRA_GROUPS]
35+
--bootstraptoken.expiration= Expiration (time.Duration) for bootstrap tokens (default: 8760h) [$BOOTSTRAPTOKEN_EXPIRATION]
36+
--bootstraptoken.token-length= Length of the random token string for bootstrap tokens (default: 16) [$BOOTSTRAPTOKEN_TOKEN_LENGTH]
37+
--bootstraptoken.token-runes= Runes which should be used for the random token string for bootstrap tokens (default: abcdefghijklmnopqrstuvwxyz0123456789)
5038
[$BOOTSTRAPTOKEN_TOKEN_RUNES]
5139
--sync.time= Sync time (time.Duration) (default: 1h) [$SYNC_TIME]
52-
--sync.recreate-before= Time duration (time.Duration) when token should be recreated (default:
53-
2190h) [$SYNC_RECREATE_BEFORE]
40+
--sync.recreate-before= Time duration (time.Duration) when token should be recreated (default: 2190h) [$SYNC_RECREATE_BEFORE]
5441
--sync.full Sync also previous tokens (full sync) [$SYNC_FULL]
5542
--cloud-provider=[azure] Cloud provider [$CLOUD_PROVIDER]
56-
--cloud-config= Cloud provider configuration path [$CLOUD_CONFIG]
57-
--azure-environment= Azure environment name [$AZURE_ENVIRONMENT]
58-
--azure.keyvault-name= Name of Keyvault to sync token [$AZURE_KEYVAULT_NAME]
59-
--azure.keyvault-secret-name= Name of Keyvault secret to sync token (default: kube-bootstrap-token)
60-
[$AZURE_KEYVAULT_SECRET_NAME]
43+
--azure.keyvault.url= URL of Keyvault to sync token [$AZURE_KEYVAULT_URL]
44+
--azure.keyvault.secret= Name of Keyvault secret to sync token (default: kube-bootstrap-token) [$AZURE_KEYVAULT_SECRET]
6145
--dry-run Dry run (do not apply to nodes) [$DRY_RUN]
6246
--server.bind= Server address (default: :8080) [$SERVER_BIND]
6347
--server.timeout.read= Server read timeout (default: 5s) [$SERVER_TIMEOUT_READ]
@@ -67,7 +51,9 @@ Help Options:
6751
-h, --help Show this help message
6852
```
6953

70-
for Azure API authentication (using ENV vars) see https://docs.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication
54+
for Azure API authentication (using ENV vars) see following documentations:
55+
- https://github.com/webdevops/go-common/blob/main/azuresdk/README.md
56+
- https://docs.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication
7157

7258
## Metrics
7359

@@ -83,15 +69,7 @@ for Azure API authentication (using ENV vars) see https://docs.microsoft.com/en-
8369

8470
### AzureTracing metrics
8571

86-
(with 22.2.0 and later)
87-
88-
Azuretracing metrics collects latency and latency from azure-sdk-for-go and creates metrics and is controllable using
89-
environment variables (eg. setting buckets, disabling metrics or disable autoreset).
90-
91-
| Metric | Description |
92-
|------------------------------------------|----------------------------------------------------------------------------------------|
93-
| `azurerm_api_ratelimit` | Azure ratelimit metrics (only on /metrics, resets after query due to limited validity) |
94-
| `azurerm_api_request_*` | Azure request count and latency as histogram |
72+
see [armclient tracing documentation](https://github.com/webdevops/go-common/blob/main/azuresdk/README.md#azuretracing-metrics)
9573

9674
#### Settings
9775

0 commit comments

Comments
 (0)