Skip to content

Commit 8c89db6

Browse files
committed
Add new parameters to the doc
1 parent 86fbed7 commit 8c89db6

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -151,27 +151,31 @@ kubectl apply -f k8s/deployment.yaml
151151
## Configuration
152152
K8s-athenz-syncer has a variety of parameters that can be configured, they are given below.
153153

154-
|Parameters |Description |Default |
155-
|:--------------------|:------------------------------------------------------------------------------------|:-----------------------------------------------|
156-
|admin-domain |Admin domain that can be specified in order to fetch admin domains from Athenz | |
157-
|auth-header |Authentication header field | |
158-
|cert |Path to X.509 certificate file to use for zms authentication |/var/run/athenz/service.cert.pem |
159-
|disable-keep-alives |Disable keep alive for zms client |true |
160-
|identity-key |Directory containing private keys for service identity |/var/run/keys/identity |
161-
|inClusterConfig |Set to true to use in cluster config |true |
162-
|key |Path to private key file for zms authentication |/var/run/athenz/service.key.pem |
163-
|kubeconfig |Absolute path to the kubeconfig file |/root/.kube/config |
164-
|log-location |Log location |/var/log/k8s-athenz-syncer/k8s-athenz-syncer.log|
165-
|log-mode |Logger mode |INFO |
166-
|ntoken-expiry |Custom nToken expiration duration |1h0m0s |
167-
|queue-delay-interval |Delay interval time for workqueue |250ms |
168-
|resync-cron |Sleep interval for controller full resync cron |1h0m0s |
169-
|secret-name |Secret name that contains private key |k8s-athenz-syncer |
170-
|service-domain |Athenz domain that contains k8s-athenz-syncer | |
171-
|service-name |Service name |k8s-athenz-syncer |
172-
|system-namespaces |A list of cluster system namespaces that you hope the controller to fetch from Athenz| |
173-
|update-cron |Sleep interval for controller update cron |1m0s |
174-
|zms-url |Athenz full zms url including api path | |
154+
|Parameters |Description |Default |
155+
|:--------------------------|:-------------------------------------------------------------------------------------|:-----------------------------------------------|
156+
|admin-domain |Admin domain that can be specified in order to fetch admin domains from Athenz | |
157+
|athenz-contact-time-cm-key |Key of ConfigMap to record the latest time that the Update Cron contacted Athenz |latest_contact |
158+
|athenz-contact-time-cm-name|Name of ConfigMap to record the latest time that the Update Cron contacted Athenz |athenzcall-config |
159+
|athenz-contact-time-cm-ns |Namespace of ConfigMap to record the latest time that the Update Cron contacted Athenz|kube-yahoo |
160+
|auth-header |Authentication header field | |
161+
|cacert |Path to X.509 ca certificate file to use for zms authentication | |
162+
|cert |Path to X.509 certificate file to use for zms authentication |/var/run/athenz/service.cert.pem |
163+
|disable-keep-alives |Disable keep alive for zms client |true |
164+
|identity-key |Directory containing private keys for service identity |/var/run/keys/identity |
165+
|inClusterConfig |Set to true to use in cluster config |true |
166+
|key |Path to private key file for zms authentication |/var/run/athenz/service.key.pem |
167+
|kubeconfig |Absolute path to the kubeconfig file |/root/.kube/config |
168+
|log-location |Log location |/var/log/k8s-athenz-syncer/k8s-athenz-syncer.log|
169+
|log-mode |Logger mode |INFO |
170+
|ntoken-expiry |Custom nToken expiration duration |1h0m0s |
171+
|queue-delay-interval |Delay interval time for workqueue |250ms |
172+
|resync-cron |Sleep interval for controller full resync cron |1h0m0s |
173+
|secret-name |Secret name that contains private key |k8s-athenz-syncer |
174+
|service-domain |Athenz domain that contains k8s-athenz-syncer | |
175+
|service-name |Service name |k8s-athenz-syncer |
176+
|system-namespaces |A list of cluster system namespaces that you hope the controller to fetch from Athenz | |
177+
|update-cron |Sleep interval for controller update cron |1m0s |
178+
|zms-url |Athenz full zms url including api path | |
175179

176180
## Usage
177181
Once the controller is up and running, the controller will create Kubernetes AthenzDomains Custom Resources in the cluster accordingly. Users and Applications can consume those AthenzDomains CR to get security policy information for access control checks.

0 commit comments

Comments
 (0)