summaryrefslogtreecommitdiffstats
path: root/roles/calico_master/README.md
diff options
context:
space:
mode:
authorDan Osborne <djosborne10@gmail.com>2017-03-10 16:07:45 -0800
committerDan Osborne <djosborne10@gmail.com>2017-03-23 13:53:46 -0700
commit7aa584b59baba5a7018d38aadd19aa7646702391 (patch)
treeccaf232790a12e81b923b4595d020deac1bfbe16 /roles/calico_master/README.md
parent33e181c39d5024ecd226567139a7b0d36683bf2c (diff)
downloadopenshift-7aa584b59baba5a7018d38aadd19aa7646702391.tar.gz
openshift-7aa584b59baba5a7018d38aadd19aa7646702391.tar.bz2
openshift-7aa584b59baba5a7018d38aadd19aa7646702391.tar.xz
openshift-7aa584b59baba5a7018d38aadd19aa7646702391.zip
Add calico.
Diffstat (limited to 'roles/calico_master/README.md')
-rw-r--r--roles/calico_master/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/roles/calico_master/README.md b/roles/calico_master/README.md
new file mode 100644
index 000000000..2d34a967c
--- /dev/null
+++ b/roles/calico_master/README.md
@@ -0,0 +1,28 @@
+# Calico (Master)
+
+Configure Calico components for the Master host.
+
+## Requirements
+
+* Ansible 2.2
+
+## Warning: This Calico Integration is in Alpha
+
+Calico shares the etcd instance used by OpenShift, and distributes client etcd certificates to each node.
+For this reason, **we do not (yet) recommend running Calico on any production-like
+cluster, or using it for any purpose besides early access testing.**
+
+## Installation
+
+To install, set the following inventory configuration parameters:
+
+* `openshift_use_calico=True`
+* `openshift_use_openshift_sdn=False`
+* `os_sdn_network_plugin_name='cni'`
+
+
+### Contact Information
+
+Author: Dan Osborne <dan@projectcalico.org>
+
+For support, join the `#openshift` channel on the [calico users slack](calicousers.slack.com).