summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/zabbix/docs/UPGRADE.md
blob: 7784f5842bd8aaa5b0d9bd0d6fdedb5b1d8a9d5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
__Upgrade__

Table of content

- [1.0.0](#100)
  * [Roles](#roles)
    + [Proxy](#proxy)
    + [Java Gateway](#java-gateway)
- [0.2.0](#020)
  * [Roles](#roles-1)
    + [Agent](#agent)
    + [Server](#server)
    + [Proxy](#proxy-1)
    + [Web](#web)
    + [Java Gateway](#java-gateway-1)

This document provides an overview of all the changes that are needed to be applied to have a correctly working environment per version. If a version is not part of this document, then there are no changes needed to apply.

## 1.5.0

### Roles

#### Agent

The following properties are added in the `zabbix_agent` role.

* `zabbix_api_timeout = 30`
* `zabbix_agent_tls_subject = "{{ zabbix_agent_tlsservercertsubject }}"`
* `zabbix_agent2_server = "{{ zabbix_agent_server }}"`
* `zabbix_agent2_serveractive = "{{ zabbix_agent_serveractive }}"`
* `zabbix_agent2_allow_key = "{{ zabbix_agent_allow_key }}"`
* `zabbix_agent2_deny_key = "{{ zabbix_agent_deny_key }}"`
* `zabbix_agent2_tls_subject = "{{ zabbix_agent2_tlsservercertsubject }}"`

NOTE: The original properties can still be used but it's suggested to update to
use the new ones.

The following properties are renamed in the `zabbix_agent` role.

| From                          | To                            |
|-------------------------------|-------------------------------|
| zabbix_url                    | zabbix_api_server_url         |
| zabbix_agent_server_url       | zabbix_api_server_url         |
| zabbix_http_user              | zabbix_api_http_user          |
| zabbix_http_password          | zabbix_api_http_password      |
| zabbix_api_user               | zabbix_api_login_user         |
| zabbix_api_pass               | zabbix_api_login_pass         |
| zabbix_validate_certs         | zabbix_api_validate_certs     |
| zabbix_create_hostgroup       | zabbix_agent_hostgroups_state |
| zabbix_macros                 | zabbix_agent_macros           |
| zabbix_inventory_mode         | zabbix_agent_inventory_mode   |
| zabbix_link_templates         | zabbix_agent_link_templates   |
| zabbix_proxy                  | zabbix_agent_proxy            |
| zabbix_update_host            | zabbix_agent_host_update      |
| zabbix_create_host            | zabbix_agent_host_state       |
| zabbix_visible_hostname       | zabbix_agent_visible_hostname |

NOTE: the old parameters are still valid but it's suggested to update to use the
new ones.

#### Proxy

The following properties are added in the `zabbix_proxy` role.

* `zabbix_api_timeout = 30`
* `zabbix_proxy_tls_subject = "{{ zabbix_proxy_tlsservercertsubject }}"`

The following properties are renamed in the `zabbix_proxy` role.

| From                       | To                              |
|----------------------------|---------------------------------|
| zabbix_server_host         | zabbix_proxy_server             |
| zabbix_server_port         | zabbix_proxy_serverport         |
| zabbix_proxy_localbuffer   | zabbix_proxy_proxylocalbuffer   |
| zabbix_proxy_offlinebuffer | zabbix_proxy_proxyofflinebuffer |
| zabbix_create_proxy        | zabbix_proxy_state              |
| zabbix_url                 | zabbix_api_server_url           |
| zabbix_http_user           | zabbix_api_http_user            |
| zabbix_http_password       | zabbix_api_http_password        |
| zabbix_api_user            | zabbix_api_login_user           |
| zabbix_api_pass            | zabbix_api_login_pass           |
| zabbix_validate_certs      | zabbix_api_validate_certs       |

NOTE: the old parameters are still valid but it's suggested to update to use the
new ones.

## 1.0.0

### Roles

#### Proxy

The following property is renamed in the `zabbix_proxy` role.

|From|To|
|----|--|
|`zabbix_version`|`zabbix_proxy_version`|

NOTE: The `zabbix_version` can still be used, but will be deprecated in later releases.

#### Java Gateway

The following properties are renamed in the `zabbix_javagateway` role.

|From|To|
|----|--|
|`zabbix_version`|`zabbix_javagateway_version`|
|`javagateway_package_state`|`zabbix_javagateway_package_state`|
|`javagateway_pidfile`|`zabbix_javagateway_pidfile`|
|`javagateway_listenip`|`zabbix_javagateway_listenip`|
|`javagateway_listenport`|`zabbix_javagateway_listenport`|
|`javagateway_startpollers`|`zabbix_javagateway_startpollers`|

NOTE: The `zabbix_version` can still be used, but will be deprecated in later releases.

## 0.2.0

### Roles

#### Agent

A 1-on-1 copy of the Ansible role `dj-wasabi.zabbix-agent` to this collection. Due to naming of roles as part of a collection, some characters (Like the `-`) are not allowed anymore. This role is therefore renamed from `zabbix-agent` to `zabbix_agent`.

Example of using the role in this collection:
```yaml
- hosts: all
  roles:
    - role: community.zabbix.zabbix_agent
      zabbix_agent_server: 192.168.33.30
      zabbix_agent_serveractive: 192.168.33.30
```

#### Server

A 1-on-1 copy of the Ansible role `dj-wasabi.zabbix-server` to this collection. Due to naming of roles as part of a collection, some characters (Like the `-`) are not allowed anymore. This role is therefore renamed from `zabbix-server` to `zabbix_server`.

Example of using the role in this collection::
```yaml
- hosts: zabbix-server
  roles:
    - role: community.zabbix.zabbix_server
      zabbix_server_database: mysql
      zabbix_server_database_long: mysql
      zabbix_server_dbport: 3306
```

#### Proxy

A 1-on-1 copy of the Ansible role `dj-wasabi.zabbix-proxy` to this collection. Due to naming of roles as part of a collection, some characters (Like the `-`) are not allowed anymore. This role is therefore renamed from `zabbix-proxy` to `zabbix_proxy`.

Example of using the role in this collection::
```yaml
- hosts: zabbix-proxy
  roles:
    - role: community.zabbix.zabbix_proxy
      zabbix_proxy_server: 192.168.1.1
      zabbix_server_database: mysql
      zabbix_server_database_long: mysql
      zabbix_server_dbport: 3306
```

#### Web

A 1-on-1 copy of the Ansible role `dj-wasabi.zabbix-web` to this collection. Due to naming of roles as part of a collection, some characters (Like the `-`) are not allowed anymore. This role is therefore renamed from `zabbix-web` to `zabbix_web`.

Example of using the role in this collection::
```yaml
- hosts: zabbix-web
  become: yes
  roles:
    - role: geerlingguy.apache
    - role: community.zabbix.zabbix_web
      zabbix_url: zabbix.mydomain.com
      zabbix_server_hostname: zabbix-server
      zabbix_server_database: mysql
      zabbix_server_database_long: mysql
      zabbix_server_dbport: 3306
```

#### Java Gateway

A 1-on-1 copy of the Ansible role `dj-wasabi.zabbix-javagateway` to this collection. Due to naming of roles as part of a collection, some characters (Like the `-`) are not allowed anymore. This role is therefore renamed from `zabbix-javagateway` to `zabbix_javagateway`.

Example of using the role in this collection::
```yaml
- hosts: zabbix-server
  roles:
    - role: community.zabbix.zabbix_server
      zabbix_server_database: mysql
      zabbix_server_database_long: mysql
      zabbix_server_dbport: 3306
      zabbix_server_javagateway: 192.168.1.1
    - role: community.zabbix.zabbix_javagateway
```