From 2d084a816d4af52f7cffe3ddb913e2b4555b7d23 Mon Sep 17 00:00:00 2001 From: Sylvain Baubeau Date: Thu, 15 Oct 2015 14:41:35 +0200 Subject: Add flannel modules documentation --- roles/flannel/README.md | 12 ++++++++++-- roles/flannel/meta/main.yml | 2 +- roles/flannel_register/README.md | 12 +++++++++++- roles/flannel_register/meta/main.yml | 2 +- 4 files changed, 23 insertions(+), 5 deletions(-) diff --git a/roles/flannel/README.md b/roles/flannel/README.md index 94cf15254..b8aa830ac 100644 --- a/roles/flannel/README.md +++ b/roles/flannel/README.md @@ -12,7 +12,15 @@ named 'flannel' available via yum, in version superior to 0.3. Role Variables -------------- -TODO +| Name | Default value | Description | +|---------------------|-----------------------------------------|-----------------------------------------------| +| flannel_interface | ansible_default_ipv4.interface | interface to use for inter-host communication | +| flannel_etcd_key | /openshift.com/network | etcd prefix | +| etcd_hosts | etcd_urls | a list of etcd endpoints | +| etcd_conf_dir | {{ openshift.common.config_base }}/node | SSL certificates directory | +| etcd_peer_ca_file | {{ etcd_conf_dir }}/ca.crt | SSL CA to use for etcd | +| etcd_peer_cert_file | Openshift SSL cert | SSL cert to use for etcd | +| etcd_peer_key_file | Openshift SSL key | SSL key to use for etcd | Dependencies ------------ @@ -24,7 +32,7 @@ Example Playbook - hosts: openshift_node roles: - - { flannel } + - { role: flannel, etcd_urls: ['https://127.0.0.1:2379'] } License ------- diff --git a/roles/flannel/meta/main.yml b/roles/flannel/meta/main.yml index a64934b3c..909bdbfa4 100644 --- a/roles/flannel/meta/main.yml +++ b/roles/flannel/meta/main.yml @@ -1,7 +1,7 @@ --- galaxy_info: author: Sylvain - description: etcd management + description: flannel management company: Red Hat, Inc. license: Apache License, Version 2.0 min_ansible_version: 1.2 diff --git a/roles/flannel_register/README.md b/roles/flannel_register/README.md index a11c8fe53..ba7541ab1 100644 --- a/roles/flannel_register/README.md +++ b/roles/flannel_register/README.md @@ -12,7 +12,17 @@ named 'flannel' available via yum, in version superior to 0.3. Role Variables -------------- -TODO +| Name | Default value | Description | +|---------------------|----------------------------------------------------|-------------------------------------------------| +| flannel_network | {{ openshift.master.portal_net }} or 172.16.1.1/16 | interface to use for inter-host communication | +| flannel_min_network | {{ min_network }} or 172.16.5.0 | beginning of IP range for the subnet allocation | +| flannel_subnet_len | /openshift.com/network | size of the subnet allocated to each host | +| flannel_etcd_key | /openshift.com/network | etcd prefix | +| etcd_hosts | etcd_urls | a list of etcd endpoints | +| etcd_conf_dir | {{ openshift.common.config_base }}/master | SSL certificates directory | +| etcd_peer_ca_file | {{ etcd_conf_dir }}/ca.crt | SSL CA to use for etcd | +| etcd_peer_cert_file | {{ etcd_conf_dir }}/master.etcd-client.crt | SSL cert to use for etcd | +| etcd_peer_key_file | {{ etcd_conf_dir }}/master.etcd-client.key | SSL key to use for etcd | Dependencies ------------ diff --git a/roles/flannel_register/meta/main.yml b/roles/flannel_register/meta/main.yml index a64934b3c..73bddcca4 100644 --- a/roles/flannel_register/meta/main.yml +++ b/roles/flannel_register/meta/main.yml @@ -1,7 +1,7 @@ --- galaxy_info: author: Sylvain - description: etcd management + description: register flannel configuration into etcd company: Red Hat, Inc. license: Apache License, Version 2.0 min_ansible_version: 1.2 -- cgit v1.2.1