Skip to content

Commit 9bc53c5

Browse files
robin-checkmkrobin-checkmk
committed
Fix terminology in docs.
1 parent 328c044 commit 9bc53c5

File tree

31 files changed

+264
-264
lines changed

31 files changed

+264
-264
lines changed

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,13 @@ if you list the `checkmk.general` collection in the playbook's [`collections`](h
114114
tasks:
115115
- name: "Run activation."
116116
activation:
117-
server_url: "http://my_server/"
118-
site: "my_site"
119-
automation_user: "my_user"
120-
automation_secret: "my_secret"
117+
server_url: "http://myserver/"
118+
site: "mysite"
119+
automation_user: "myuser"
120+
automation_secret: "mysecret"
121121
force_foreign_changes: 'true'
122122
sites:
123-
- "my_site"
123+
- "mysite"
124124
```
125125
### More information about Checkmk
126126

‎playbooks/vars/auth.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
# Provice the URL and credentials to your Checkmk site here #
3-
checkmk_var_server_url: "http://localhost/"
4-
checkmk_var_site: "my_site"
5-
checkmk_var_automation_user: "cmkadmin"
6-
checkmk_var_automation_secret: "cmk"
3+
checkmk_var_server_url: "http://myserver/"
4+
checkmk_var_site: "mysite"
5+
checkmk_var_automation_user: "myuser"
6+
checkmk_var_automation_secret: "mysecret"
77
checkmk_agent_user: "{{ checkmk_var_automation_user }}"
88
checkmk_agent_pass: "{{ checkmk_var_automation_secret }}"
99

‎playbooks/vars/config.yml.example

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
checkmk_var_server_url: "http://localhost/"
3-
checkmk_var_site: "my_site"
4-
checkmk_var_automation_user: "automation"
5-
checkmk_var_automation_secret: "$SECRET"
2+
checkmk_var_server_url: "http://myserver/"
3+
checkmk_var_site: "mysite"
4+
checkmk_var_automation_user: "myuser"
5+
checkmk_var_automation_secret: "mysecret"
66

77
checkmk_var_folders:
88
- path: /test

‎plugins/lookup/folder.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@
9696
lookup('checkmk.general.folder',
9797
'~tests',
9898
server_url=my_server_url,
99-
site=my_site,
100-
automation_user=my_user,
101-
automation_secret=my_secret,
99+
site=mysite,
100+
automation_user=myuser,
101+
automation_secret=mysecret,
102102
validate_certs=False
103103
)
104104
}}"

‎plugins/lookup/folders.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@
110110
show_hosts=False,
111111
recursive=True,
112112
server_url=my_server_url,
113-
site=my_site,
114-
automation_user=my_user,
115-
automation_secret=my_secret,
113+
site=mysite,
114+
automation_user=myuser,
115+
automation_secret=mysecret,
116116
validate_certs=False
117117
)
118118
}}"
@@ -129,9 +129,9 @@
129129
show_hosts=True,
130130
recursive=True,
131131
server_url=my_server_url,
132-
site=my_site,
133-
automation_user=my_user,
134-
automation_secret=my_secret,
132+
site=mysite,
133+
automation_user=myuser,
134+
automation_secret=mysecret,
135135
validate_certs=False
136136
)
137137
}}"

‎plugins/lookup/host.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@
103103
'example.com',
104104
effective_attributes=True,
105105
server_url=my_server_url,
106-
site=my_site,
107-
automation_user=my_user,
108-
automation_secret=my_secret,
106+
site=mysite,
107+
automation_user=myuser,
108+
automation_secret=mysecret,
109109
validate_certs=False
110110
)
111111
}}"

‎plugins/lookup/hosts.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@
9898
lookup('checkmk.general.hosts',
9999
effective_attributes=True,
100100
server_url=my_server_url,
101-
site=my_site,
102-
automation_user=my_user,
103-
automation_secret=my_secret,
101+
site=mysite,
102+
automation_user=myuser,
103+
automation_secret=mysecret,
104104
validate_certs=False
105105
)
106106
}}"

‎plugins/lookup/version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@
9191
version: "{{ lookup('checkmk.general.version',
9292
server_url + '/' + site,
9393
validate_certs=False,
94-
automation_user=my_user,
95-
automation_secret=my_secret
94+
automation_user=myuser,
95+
automation_secret=mysecret
9696
)}}"
9797
9898
- name: "Use variables outside the module call."

‎plugins/modules/activation.py

+14-14
Original file line numberDiff line numberDiff line change
@@ -46,35 +46,35 @@
4646
EXAMPLES = r"""
4747
- name: "Start activation on all sites."
4848
checkmk.general.activation:
49-
server_url: "http://my_server/"
50-
site: "my_site"
51-
automation_user: "my_user"
52-
automation_secret: "my_secret"
49+
server_url: "http://myserver/"
50+
site: "mysite"
51+
automation_user: "myuser"
52+
automation_secret: "mysecret"
5353
run_once: 'true'
5454
5555
- name: "Start activation on a specific site."
5656
checkmk.general.activation:
57-
server_url: "http://my_server/"
58-
site: "my_site"
59-
automation_user: "my_user"
60-
automation_secret: "my_secret"
57+
server_url: "http://myserver/"
58+
site: "mysite"
59+
automation_user: "myuser"
60+
automation_secret: "mysecret"
6161
sites:
62-
- "my_site"
62+
- "mysite"
6363
run_once: 'true'
6464
6565
- name: "Start activation including foreign changes."
6666
checkmk.general.activation:
67-
server_url: "http://my_server/"
68-
site: "my_site"
69-
automation_user: "my_user"
70-
automation_secret: "my_secret"
67+
server_url: "http://myserver/"
68+
site: "mysite"
69+
automation_user: "myuser"
70+
automation_secret: "mysecret"
7171
force_foreign_changes: 'true'
7272
run_once: 'true'
7373
7474
- name: "Activate changes including foreign changes and wait for completion."
7575
checkmk.general.activation:
7676
server_url: "http://localhost/"
77-
site: "my_site"
77+
site: "mysite"
7878
automation_user: "automation"
7979
automation_secret: "$SECRET"
8080
redirect: 'true'

‎plugins/modules/bakery.py

+12-12
Original file line numberDiff line numberDiff line change
@@ -47,28 +47,28 @@
4747
# Bake all agents without signing, as example in a fresh installation without a signature key.
4848
- name: "Bake all agents without signing."
4949
checkmk.general.bakery:
50-
server_url: "http://my_server/"
51-
site: "my_site"
52-
automation_user: "my_user"
53-
automation_secret: "my_secret"
50+
server_url: "http://myserver/"
51+
site: "mysite"
52+
automation_user: "myuser"
53+
automation_secret: "mysecret"
5454
state: "baked"
5555
# Sign all agents.
5656
- name: "Sign all agents."
5757
checkmk.general.bakery:
58-
server_url: "http://my_server/"
59-
site: "my_site"
60-
automation_user: "my_user"
61-
automation_secret: "my_secret"
58+
server_url: "http://myserver/"
59+
site: "mysite"
60+
automation_user: "myuser"
61+
automation_secret: "mysecret"
6262
signature_key_id: 1
6363
signature_key_passphrase: "secretkey"
6464
state: "signed"
6565
# Bake and sign all agents.
6666
- name: "Bake and sign all agents."
6767
checkmk.general.bakery:
68-
server_url: "http://my_server/"
69-
site: "my_site"
70-
automation_user: "my_user"
71-
automation_secret: "my_secret"
68+
server_url: "http://myserver/"
69+
site: "mysite"
70+
automation_user: "myuser"
71+
automation_secret: "mysecret"
7272
signature_key_id: 1
7373
signature_key_passphrase: "secretkey"
7474
state: "baked_signed"

‎plugins/modules/contact_group.py

+20-20
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@
5858
# Create a single contact group.
5959
- name: "Create a single contact group."
6060
checkmk.general.contact_group:
61-
server_url: "http://my_server/"
62-
site: "my_site"
63-
automation_user: "my_user"
64-
automation_secret: "my_secret"
61+
server_url: "http://myserver/"
62+
site: "mysite"
63+
automation_user: "myuser"
64+
automation_secret: "mysecret"
6565
name: "my_contact_group"
6666
title: "My Contact Group"
6767
customer: "provider"
@@ -70,10 +70,10 @@
7070
# Create several contact groups.
7171
- name: "Create several contact groups."
7272
checkmk.general.contact_group:
73-
server_url: "http://my_server/"
74-
site: "my_site"
75-
automation_user: "my_user"
76-
automation_secret: "my_secret"
73+
server_url: "http://myserver/"
74+
site: "mysite"
75+
automation_user: "myuser"
76+
automation_secret: "mysecret"
7777
customer: "provider"
7878
groups:
7979
- name: "my_contact_group_one"
@@ -87,10 +87,10 @@
8787
# Create several contact groups.
8888
- name: "Create several contact groups."
8989
checkmk.general.contact_group:
90-
server_url: "http://my_server/"
91-
site: "my_site"
92-
automation_user: "my_user"
93-
automation_secret: "my_secret"
90+
server_url: "http://myserver/"
91+
site: "mysite"
92+
automation_user: "myuser"
93+
automation_secret: "mysecret"
9494
customer: "provider"
9595
groups:
9696
- name: "my_contact_group_one"
@@ -102,20 +102,20 @@
102102
# Delete a single contact group.
103103
- name: "Create a single contact group."
104104
checkmk.general.contact_group:
105-
server_url: "http://my_server/"
106-
site: "my_site"
107-
automation_user: "my_user"
108-
automation_secret: "my_secret"
105+
server_url: "http://myserver/"
106+
site: "mysite"
107+
automation_user: "myuser"
108+
automation_secret: "mysecret"
109109
name: "my_contact_group"
110110
state: "absent"
111111
112112
# Delete several contact groups.
113113
- name: "Delete several contact groups."
114114
checkmk.general.contact_group:
115-
server_url: "http://my_server/"
116-
site: "my_site"
117-
automation_user: "my_user"
118-
automation_secret: "my_secret"
115+
server_url: "http://myserver/"
116+
site: "mysite"
117+
automation_user: "myuser"
118+
automation_secret: "mysecret"
119119
groups:
120120
- name: "my_contact_group_one"
121121
- name: "my_contact_group_two"

‎plugins/modules/discovery.py

+16-16
Original file line numberDiff line numberDiff line change
@@ -63,34 +63,34 @@
6363
# Create a single host.
6464
- name: "Add newly discovered services on host."
6565
checkmk.general.discovery:
66-
server_url: "http://my_server/"
67-
site: "my_site"
68-
automation_user: "my_user"
69-
automation_secret: "my_secret"
66+
server_url: "http://myserver/"
67+
site: "mysite"
68+
automation_user: "myuser"
69+
automation_secret: "mysecret"
7070
host_name: "my_host"
7171
state: "new"
7272
- name: "Add newly discovered services, update labels and remove vanished services on host."
7373
checkmk.general.discovery:
74-
server_url: "http://my_server/"
75-
site: "my_site"
76-
automation_user: "my_user"
77-
automation_secret: "my_secret"
74+
server_url: "http://myserver/"
75+
site: "mysite"
76+
automation_user: "myuser"
77+
automation_secret: "mysecret"
7878
host_name: "my_host"
7979
state: "fix_all"
8080
- name: "Add newly discovered services on hosts. (Bulk)"
8181
checkmk.general.discovery:
82-
server_url: "http://my_server/"
83-
site: "my_site"
84-
automation_user: "my_user"
85-
automation_secret: "my_secret"
82+
server_url: "http://myserver/"
83+
site: "mysite"
84+
automation_user: "myuser"
85+
automation_secret: "mysecret"
8686
hosts: ["my_host_0", "my_host_1"]
8787
state: "new"
8888
- name: "Add newly discovered services, update labels and remove vanished services on host; 3 at once (Bulk)"
8989
checkmk.general.discovery:
90-
server_url: "http://my_server/"
91-
site: "my_site"
92-
automation_user: "my_user"
93-
automation_secret: "my_secret"
90+
server_url: "http://myserver/"
91+
site: "mysite"
92+
automation_user: "myuser"
93+
automation_secret: "mysecret"
9494
hosts: ["my_host_0", "my_host_1", "my_host_2", "my_host_3", "my_host_4", "my_host_5"]
9595
state: "fix_all"
9696
bulk_size: 3

‎plugins/modules/downtime.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
- name: "Schedule host downtime."
9595
checkmk.general.downtime:
9696
server_url: "{{ checkmk_var_server_url }}"
97-
site: "{{ my_site }}"
97+
site: "{{ mysite }}"
9898
automation_user: "{{ checkmk_var_automation_user }}"
9999
automation_secret: "{{ checkmk_var_automation_secret }}"
100100
host_name: my_host
@@ -107,7 +107,7 @@
107107
- name: "Schedule service downtimes for two given services."
108108
checkmk.general.downtime:
109109
server_url: "{{ checkmk_var_server_url }}"
110-
site: "{{ my_site }}"
110+
site: "{{ mysite }}"
111111
automation_user: "{{ checkmk_var_automation_user }}"
112112
automation_secret: "{{ checkmk_var_automation_secret }}"
113113
host_name: my_host
@@ -122,7 +122,7 @@
122122
- name: "Delete all service downtimes for two given services."
123123
checkmk.general.downtime:
124124
server_url: "{{ checkmk_var_server_url }}"
125-
site: "{{ my_site }}"
125+
site: "{{ mysite }}"
126126
automation_user: "{{ checkmk_var_automation_user }}"
127127
automation_secret: "{{ checkmk_var_automation_secret }}"
128128
host_name: my_host

0 commit comments

Comments
 (0)