Skip to content

Commit 92e9436

Browse files
committed
Prepare 0.7.0 release
1 parent 7ee4830 commit 92e9436

File tree

6 files changed

+26
-93
lines changed

6 files changed

+26
-93
lines changed

.ansible-lint

+1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ offline: true
33
exclude_paths:
44
- .github/
55
skip_list:
6+
- schema[meta]
67
- yaml[line-length]

CHANGELOG.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# Changelog
22

3-
## 0.6.1 (Unreleased)
3+
## 0.7.0 (July 6, 2023)
44

55
BREAKING CHANGES:
66

7-
- `spdy` parameter `listen` is removed
8-
- `http2` parameter for `listen` is removed
7+
- Two parameters have been removed from the `listen` dictionary:
8+
- `spdy` -> This parameter is no longer supported.
9+
- `http2` -> This parameter has been replaced by the `http2` directive. To enable HTTP2, use the `enable` parameter in the newly implemented `http2` module/dictionary:
10+
11+
```yaml
12+
http2:
13+
enable: true
14+
```
915
1016
ENHANCEMENTS:
1117
18+
- Initial pass at implementing directives for the `http2` (officially named `http_v2`) module.
1219
- Bump the Ansible `community.general` collection to `7.1.0`, `ansible.posix` collection to `1.5.4`, `community.crypto` collection to `2.14.0`, and `community.docker` collection to `3.4.7`.
13-
- Options from `http_v2` module are implemented.
1420

1521
BUG FIXES:
1622

README.md

+3-77
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx__config-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx_config)
22
[![Molecule CI/CD](https://github.com/nginxinc/ansible-role-nginx-config/workflows/Molecule%20CI/CD/badge.svg)](https://github.com/nginxinc/ansible-role-nginx-config/actions)
33
[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4+
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
45

56
# 👾 *Help make the NGINX config Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾
67

@@ -76,84 +77,9 @@ git clone https://github.com/nginxinc/ansible-role-nginx-config.git
7677

7778
## Platforms
7879

79-
The NGINX config Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html#mainline) and [NGINX Plus](https://www.nginx.com/products/technical-specs/):
80-
81-
### NGINX Open Source
82-
83-
```yaml
84-
AlmaLinux:
85-
- 8
86-
- 9
87-
Alpine:
88-
- 3.14
89-
- 3.15
90-
- 3.16
91-
- 3.17
92-
Amazon Linux:
93-
- 2
94-
CentOS:
95-
- 7.4+
96-
Debian:
97-
- bullseye (11)
98-
Oracle Linux:
99-
- 7
100-
- 8
101-
- 9
102-
Red Hat:
103-
- 7.4+
104-
- 8
105-
- 9
106-
Rocky Linux:
107-
- 8
108-
- 9
109-
SUSE/SLES:
110-
- 12
111-
- 15
112-
Ubuntu:
113-
- bionic (18.04)
114-
- focal (20.04)
115-
- impish (21.10)
116-
- jammy (22.04)
117-
```
80+
The NGINX config Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html#mainline) and [NGINX Plus](https://www.nginx.com/products/technical-specs/).
11881

119-
### NGINX Plus
120-
121-
```yaml
122-
AlmaLinux:
123-
- 8
124-
- 9
125-
Alpine:
126-
- 3.13
127-
- 3.14
128-
- 3.15
129-
- 3.16
130-
- 3.17
131-
Amazon Linux 2:
132-
- any
133-
CentOS:
134-
- 7.4+
135-
Debian:
136-
- bullseye (11)
137-
FreeBSD:
138-
- 12.1+
139-
- 13
140-
Oracle Linux:
141-
- 7.4+
142-
Red Hat:
143-
- 7.4+
144-
- 8
145-
- 9
146-
Rocky Linux:
147-
- 8
148-
- 9
149-
SUSE/SLES:
150-
- 12
151-
- 15
152-
Ubuntu:
153-
- bionic (18.04)
154-
- focal (20.04)
155-
- jammy (22.04)
156-
```
82+
***Note:** You should be able to use this role to configure any NGINX installation -- wherever/however it's been installed -- at your own risk. Any potential bugs with the role involving unsupported installation methods/platforms will be addressed in a best effort manner and might be outright dismissed.*
15783

15884
## Role Variables
15985

defaults/main/template.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -272,12 +272,12 @@ nginx_config_http_template:
272272
variables_hash_bucket_size: 64 # Available only in the 'http' context
273273
variables_hash_max_size: 1024 # Available only in the 'http' context
274274
http2: # Configure HTTP2
275-
enable: false
276-
body_preread_size: 64k
275+
enable: false # Boolean -- Not available in the 'location' context
276+
body_preread_size: 64k # Not available in the 'location' context
277277
chunk_size: 8k
278-
max_concurrent_streams: 128
279-
recv_buffer_size: 256k
280-
recv_timeout: 20s
278+
max_concurrent_streams: 128 # Number -- Not available in the 'location' context
279+
recv_buffer_size: 256k # Only available in the 'http' context
280+
recv_timeout: 20s # Not available in the 'location' context
281281
ssl: # Configure SSL
282282
buffer_size: 16k
283283
certificate: /path/to/file # String or a list of strings

meta/main.yml

+6-4
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,23 @@ galaxy_info:
77

88
license: Apache License, Version 2.0
99

10-
min_ansible_version: "2.12"
10+
min_ansible_version: '2.12'
1111

1212
platforms:
1313
- name: Alpine
1414
versions: [all]
1515
- name: Amazon Linux
1616
versions: ['2', '2023']
1717
- name: Debian
18-
versions: [bullseye]
18+
versions: [bullseye, bookworm]
1919
- name: EL
2020
versions: ['7', '8', '9']
2121
- name: FreeBSD
22-
versions: ['12.1']
22+
versions: ['12.1', '12.2', '12.3', '12.4', '13.0', '13.1', '13.2']
23+
- name: OracleLinux
24+
versions: ['7', '8', '9']
2325
- name: Ubuntu
24-
versions: [bionic, focal, impish, jammy]
26+
versions: [focal, jammy, kinetic, lunar]
2527
- name: SLES
2628
versions: ['12', '15']
2729

templates/http/modules.j2

+1-3
Original file line numberDiff line numberDiff line change
@@ -333,15 +333,14 @@ sub_filter_types {{ sub_filter['types'] if sub_filter['types'] is string else su
333333

334334
{# NGINX HTTP v2 -- ngx_http_v2_module #}
335335
{% macro http2(http2, scope='http') %}
336-
{% if http2 is defined %}
337336
{% if scope != 'location' %}{# The following scoped directives are not available in the 'location' context #}
338337
{% if http2['enabled'] is defined and http2['enabled'] is boolean %}
339338
http2 {{ http2['enabled'] | ternary('on', 'off') }};
340339
{% endif %}
341340
{% if http2['body_preread_size'] is defined %}
342341
http2_body_preread_size {{ http2['body_preread_size'] }};
343342
{% endif %}
344-
{% if http2['max_concurrent_streams'] is defined %}
343+
{% if http2['max_concurrent_streams'] is defined and http2['max_concurrent_streams'] is number %}
345344
http2_max_concurrent_streams {{ http2['max_concurrent_streams'] }};
346345
{% endif %}
347346
{% endif %}
@@ -351,6 +350,5 @@ http2_recv_buffer_size {{ http2['recv_buffer_size'] }};
351350
{% if http2['chunk_size'] is defined %}
352351
http2_chunk_size {{ http2['chunk_size'] }};
353352
{% endif %}
354-
{% endif %}
355353

356354
{% endmacro %}

0 commit comments

Comments
 (0)