summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc
diff options
context:
space:
mode:
authorKenny Woodson <kwoodson@redhat.com>2017-02-12 22:33:45 -0500
committerKenny Woodson <kwoodson@redhat.com>2017-02-20 20:12:16 -0500
commit0460d54961753bc3bdab4038a1946de08d11097c (patch)
tree92e7deeddb87025a95bdb13ac0d1fc1deb45a1f0 /roles/lib_openshift/src/doc
parentc9563d87c6de11503c5e8fe29a794b8c2846afcc (diff)
downloadopenshift-0460d54961753bc3bdab4038a1946de08d11097c.tar.gz
openshift-0460d54961753bc3bdab4038a1946de08d11097c.tar.bz2
openshift-0460d54961753bc3bdab4038a1946de08d11097c.tar.xz
openshift-0460d54961753bc3bdab4038a1946de08d11097c.zip
Adding oadm_ca to lib_openshift.
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r--roles/lib_openshift/src/doc/certificate_authority96
1 files changed, 96 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/certificate_authority b/roles/lib_openshift/src/doc/certificate_authority
new file mode 100644
index 000000000..be6861444
--- /dev/null
+++ b/roles/lib_openshift/src/doc/certificate_authority
@@ -0,0 +1,96 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_secret
+short_description: Module to manage openshift certificate authority
+description:
+ - Wrapper around the openshift `oc adm ca` command.
+options:
+ state:
+ description:
+ - Present is the only supported state. The state present means that `oc adm ca` will generate a certificate
+ - When create-master-certs is desired then the following parameters are passed.
+ - ['cert_dir', 'hostnames', 'master', 'public_master', 'overwrite', 'signer_name']
+ - When create-key-pair is desired then the following parameters are passed.
+ - ['private_key', 'public_key']
+ - When create-server-cert is desired then the following parameters are passed.
+ - ['cert', 'key', 'signer_cert', 'signer_key', 'signer_serial']
+ required: false
+ default: present
+ choices: ["present"]
+ aliases: []
+ kubeconfig:
+ description:
+ - The path for the kubeconfig file to use for authentication
+ required: false
+ default: /etc/origin/master/admin.kubeconfig
+ aliases: []
+ debug:
+ description:
+ - Turn on debug output.
+ required: false
+ default: False
+ aliases: []
+ cmd:
+ description:
+ - The sub command given for `oc adm ca`
+ required: false
+ default: None
+ choices:
+ - create-master-certs
+ - create-key-pair
+ - create-server-cert
+ aliases: []
+ cert_dir:
+ description:
+ - The directory to place the certificates.
+ required: false
+ default: False
+ aliases: []
+author:
+- "Kenny Woodson <kwoodson@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+- name: create secret
+ oc_secret:
+ state: present
+ namespace: openshift-infra
+ name: metrics-deployer
+ files:
+ - name: nothing
+ path: /dev/null
+ register: secretout
+ run_once: true
+
+- name: get ca from hawkular
+ oc_secret:
+ state: list
+ namespace: openshift-infra
+ name: hawkular-metrics-certificate
+ decode: True
+ register: hawkout
+ run_once: true
+
+- name: Create secrets
+ oc_secret:
+ namespace: mynamespace
+ name: mysecrets
+ contents:
+ - path: data.yml
+ data: "{{ data_content }}"
+ - path: auth-keys
+ data: "{{ auth_keys_content }}"
+ - path: configdata.yml
+ data: "{{ configdata_content }}"
+ - path: cert.crt
+ data: "{{ cert_content }}"
+ - path: key.pem
+ data: "{{ osso_site_key_content }}"
+ - path: ca.cert.pem
+ data: "{{ ca_cert_content }}"
+ register: secretout
+'''