Skip to content

Commit

Permalink
Fix terminology in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
robin-checkmk committed Mar 26, 2024
1 parent 328c044 commit 9bc53c5
Show file tree
Hide file tree
Showing 31 changed files with 264 additions and 264 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ if you list the `checkmk.general` collection in the playbook's [`collections`](h
tasks:
- name: "Run activation."
activation:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
force_foreign_changes: 'true'
sites:
- "my_site"
- "mysite"
```
### More information about Checkmk
Expand Down
8 changes: 4 additions & 4 deletions playbooks/vars/auth.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
# Provice the URL and credentials to your Checkmk site here #
checkmk_var_server_url: "http://localhost/"
checkmk_var_site: "my_site"
checkmk_var_automation_user: "cmkadmin"
checkmk_var_automation_secret: "cmk"
checkmk_var_server_url: "http://myserver/"
checkmk_var_site: "mysite"
checkmk_var_automation_user: "myuser"
checkmk_var_automation_secret: "mysecret"
checkmk_agent_user: "{{ checkmk_var_automation_user }}"
checkmk_agent_pass: "{{ checkmk_var_automation_secret }}"

Expand Down
8 changes: 4 additions & 4 deletions playbooks/vars/config.yml.example
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
checkmk_var_server_url: "http://localhost/"
checkmk_var_site: "my_site"
checkmk_var_automation_user: "automation"
checkmk_var_automation_secret: "$SECRET"
checkmk_var_server_url: "http://myserver/"
checkmk_var_site: "mysite"
checkmk_var_automation_user: "myuser"
checkmk_var_automation_secret: "mysecret"

checkmk_var_folders:
- path: /test
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/folder.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@
lookup('checkmk.general.folder',
'~tests',
server_url=my_server_url,
site=my_site,
automation_user=my_user,
automation_secret=my_secret,
site=mysite,
automation_user=myuser,
automation_secret=mysecret,
validate_certs=False
)
}}"
Expand Down
12 changes: 6 additions & 6 deletions plugins/lookup/folders.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@
show_hosts=False,
recursive=True,
server_url=my_server_url,
site=my_site,
automation_user=my_user,
automation_secret=my_secret,
site=mysite,
automation_user=myuser,
automation_secret=mysecret,
validate_certs=False
)
}}"
Expand All @@ -129,9 +129,9 @@
show_hosts=True,
recursive=True,
server_url=my_server_url,
site=my_site,
automation_user=my_user,
automation_secret=my_secret,
site=mysite,
automation_user=myuser,
automation_secret=mysecret,
validate_certs=False
)
}}"
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/host.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@
'example.com',
effective_attributes=True,
server_url=my_server_url,
site=my_site,
automation_user=my_user,
automation_secret=my_secret,
site=mysite,
automation_user=myuser,
automation_secret=mysecret,
validate_certs=False
)
}}"
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/hosts.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@
lookup('checkmk.general.hosts',
effective_attributes=True,
server_url=my_server_url,
site=my_site,
automation_user=my_user,
automation_secret=my_secret,
site=mysite,
automation_user=myuser,
automation_secret=mysecret,
validate_certs=False
)
}}"
Expand Down
4 changes: 2 additions & 2 deletions plugins/lookup/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@
version: "{{ lookup('checkmk.general.version',
server_url + '/' + site,
validate_certs=False,
automation_user=my_user,
automation_secret=my_secret
automation_user=myuser,
automation_secret=mysecret
)}}"
- name: "Use variables outside the module call."
Expand Down
28 changes: 14 additions & 14 deletions plugins/modules/activation.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,35 +46,35 @@
EXAMPLES = r"""
- name: "Start activation on all sites."
checkmk.general.activation:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
run_once: 'true'
- name: "Start activation on a specific site."
checkmk.general.activation:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
sites:
- "my_site"
- "mysite"
run_once: 'true'
- name: "Start activation including foreign changes."
checkmk.general.activation:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
force_foreign_changes: 'true'
run_once: 'true'
- name: "Activate changes including foreign changes and wait for completion."
checkmk.general.activation:
server_url: "http://localhost/"
site: "my_site"
site: "mysite"
automation_user: "automation"
automation_secret: "$SECRET"
redirect: 'true'
Expand Down
24 changes: 12 additions & 12 deletions plugins/modules/bakery.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,28 @@
# Bake all agents without signing, as example in a fresh installation without a signature key.
- name: "Bake all agents without signing."
checkmk.general.bakery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
state: "baked"
# Sign all agents.
- name: "Sign all agents."
checkmk.general.bakery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
signature_key_id: 1
signature_key_passphrase: "secretkey"
state: "signed"
# Bake and sign all agents.
- name: "Bake and sign all agents."
checkmk.general.bakery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
signature_key_id: 1
signature_key_passphrase: "secretkey"
state: "baked_signed"
Expand Down
40 changes: 20 additions & 20 deletions plugins/modules/contact_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@
# Create a single contact group.
- name: "Create a single contact group."
checkmk.general.contact_group:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
name: "my_contact_group"
title: "My Contact Group"
customer: "provider"
Expand All @@ -70,10 +70,10 @@
# Create several contact groups.
- name: "Create several contact groups."
checkmk.general.contact_group:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
customer: "provider"
groups:
- name: "my_contact_group_one"
Expand All @@ -87,10 +87,10 @@
# Create several contact groups.
- name: "Create several contact groups."
checkmk.general.contact_group:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
customer: "provider"
groups:
- name: "my_contact_group_one"
Expand All @@ -102,20 +102,20 @@
# Delete a single contact group.
- name: "Create a single contact group."
checkmk.general.contact_group:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
name: "my_contact_group"
state: "absent"
# Delete several contact groups.
- name: "Delete several contact groups."
checkmk.general.contact_group:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
groups:
- name: "my_contact_group_one"
- name: "my_contact_group_two"
Expand Down
32 changes: 16 additions & 16 deletions plugins/modules/discovery.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,34 +63,34 @@
# Create a single host.
- name: "Add newly discovered services on host."
checkmk.general.discovery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
host_name: "my_host"
state: "new"
- name: "Add newly discovered services, update labels and remove vanished services on host."
checkmk.general.discovery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
host_name: "my_host"
state: "fix_all"
- name: "Add newly discovered services on hosts. (Bulk)"
checkmk.general.discovery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
hosts: ["my_host_0", "my_host_1"]
state: "new"
- name: "Add newly discovered services, update labels and remove vanished services on host; 3 at once (Bulk)"
checkmk.general.discovery:
server_url: "http://my_server/"
site: "my_site"
automation_user: "my_user"
automation_secret: "my_secret"
server_url: "http://myserver/"
site: "mysite"
automation_user: "myuser"
automation_secret: "mysecret"
hosts: ["my_host_0", "my_host_1", "my_host_2", "my_host_3", "my_host_4", "my_host_5"]
state: "fix_all"
bulk_size: 3
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/downtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
- name: "Schedule host downtime."
checkmk.general.downtime:
server_url: "{{ checkmk_var_server_url }}"
site: "{{ my_site }}"
site: "{{ mysite }}"
automation_user: "{{ checkmk_var_automation_user }}"
automation_secret: "{{ checkmk_var_automation_secret }}"
host_name: my_host
Expand All @@ -107,7 +107,7 @@
- name: "Schedule service downtimes for two given services."
checkmk.general.downtime:
server_url: "{{ checkmk_var_server_url }}"
site: "{{ my_site }}"
site: "{{ mysite }}"
automation_user: "{{ checkmk_var_automation_user }}"
automation_secret: "{{ checkmk_var_automation_secret }}"
host_name: my_host
Expand All @@ -122,7 +122,7 @@
- name: "Delete all service downtimes for two given services."
checkmk.general.downtime:
server_url: "{{ checkmk_var_server_url }}"
site: "{{ my_site }}"
site: "{{ mysite }}"
automation_user: "{{ checkmk_var_automation_user }}"
automation_secret: "{{ checkmk_var_automation_secret }}"
host_name: my_host
Expand Down
Loading

0 comments on commit 9bc53c5

Please sign in to comment.