Skip to content

Commit

Permalink
Merge pull request #17 from zlabjp/add-new-flags-to-the-doc
Browse files Browse the repository at this point in the history 
Add new parameters to the doc
  • Loading branch information
@CatherineZhuang
CatherineZhuang authored Aug 13, 2020
2 parents 86fbed7 + 8c89db6 commit c25d733
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,27 +151,31 @@ kubectl apply -f k8s/deployment.yaml
## Configuration
K8s-athenz-syncer has a variety of parameters that can be configured, they are given below.

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

## Usage
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.
Expand Down

0 comments on commit c25d733

Please sign in to comment.