Mirrors/ansible-collection-hetzner-hcloud
2
0
Fork 0
mirror of https://github.com/ansible-collections/hetzner.hcloud synced 2024-09-20 06:22:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: fix certificates module options and examples (#377)

Browse source 
##### SUMMARY

Closes #374 
Closes #375

##### ISSUE TYPE

- Docs Pull Request


##### COMPONENT NAME

hcloud_certificates
This commit is contained in:
Jonas L 2023-10-30 17:30:49 +01:00 committed by GitHub
parent de1eed9cb5
commit c491799f6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
plugins/modules/hcloud_certificate.py
View file

@ -35,17 +35,17 @@ options:
certificate:
description:
- Certificate and chain in PEM format, in order so that each record directly certifies the one preceding.
- Required if certificate does not exist.
- Required if certificate does not exist and I(type=uploaded).
type: str
private_key:
description:
- Certificate key in PEM format.
- Required if certificate does not exist.
- Required if certificate does not exist and I(type=uploaded).
type: str
domain_names:
description:
- Certificate key in PEM format.
- Required if certificate does not exist.
- Domains and subdomains that should be contained in the Certificate issued by Let's Encrypt.
- Required if I(type=managed).
type: list
default: [ ]
elements: str
@ -70,20 +70,29 @@ EXAMPLES = """
- name: Create a basic certificate
hetzner.hcloud.hcloud_certificate:
name: my-certificate
certificate: ssh-rsa AAAjjk76kgf...Xt
private_key: ssh-rsa AAAjjk76kgf...Xt
certificate: -----BEGIN CERTIFICATE-----...
private_key: -----BEGIN PRIVATE KEY-----...
state: present
- name: Create a certificate with labels
hetzner.hcloud.hcloud_certificate:
name: my-certificate
certificate: ssh-rsa AAAjjk76kgf...Xt
private_key: ssh-rsa AAAjjk76kgf...Xt
certificate: -----BEGIN CERTIFICATE-----...
private_key: -----BEGIN PRIVATE KEY-----...
labels:
key: value
mylabel: 123
state: present
- name: Create a managed certificate
hetzner.hcloud.hcloud_certificate:
name: my-certificate
type: managed
domain_names:
- example.com
- www.example.com
state: present
- name: Ensure the certificate is absent (remove if needed)
hetzner.hcloud.hcloud_certificate:
name: my-certificate