Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve nginx::package_source documentation #1577

Merged
merged 1 commit into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
* [`Nginx::ErrorLogSeverity`](#Nginx--ErrorLogSeverity)
* [`Nginx::GzipProxied`](#Nginx--GzipProxied): custom type for gzip_proxied
* [`Nginx::LogFormat`](#Nginx--LogFormat)
* [`Nginx::Package_source`](#Nginx--Package_source): Where to download NGINX from There are three versions of NGINX available: * stable (`nginx` or `nginx-stable`); * mainline (`nginx-mainline`
* [`Nginx::Size`](#Nginx--Size)
* [`Nginx::StringMappings`](#Nginx--StringMappings): custom type for the `map` variable mapping
* [`Nginx::Time`](#Nginx--Time)
Expand Down Expand Up @@ -1449,7 +1450,7 @@ Default value: `$nginx::params::package_name`

##### <a name="-nginx--package_source"></a>`package_source`

Data type: `String`
Data type: `Nginx::Package_source`



Expand Down Expand Up @@ -5186,6 +5187,23 @@ Variant[String[1], Struct[{
}]]
```

### <a name="Nginx--Package_source"></a>`Nginx::Package_source`

Where to download NGINX from

There are three versions of NGINX available:
* stable (`nginx` or `nginx-stable`);
* mainline (`nginx-mainline`);
* passenger (`passenger`).

The mainline branch gets new features and bugfixes sooner but might introduce new bugs as well. Critical bugfixes are backported to the stable branch.

In general, the stable release is recommended, but the mainline release is typically quite stable as well.

In addition, Phusion provide packages for NGINX + Passenger (`passenger`).

Alias of `Enum['nginx', 'nginx-stable', 'nginx-mainline', 'passenger']`

### <a name="Nginx--Size"></a>`Nginx::Size`

The Nginx::Size data type.
Expand Down
2 changes: 1 addition & 1 deletion manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
### START Package Configuration ###
String $package_ensure = installed,
String $package_name = $nginx::params::package_name,
String $package_source = 'nginx',
Nginx::Package_source $package_source = 'nginx',
Optional[String] $package_flavor = undef,
Boolean $manage_repo = $nginx::params::manage_repo,
Hash[String[1], String[1]] $mime_types = $nginx::params::mime_types,
Expand Down
18 changes: 18 additions & 0 deletions types/package_source.pp
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Where to download NGINX from
#
# There are three versions of NGINX available:
# * stable (`nginx` or `nginx-stable`);
# * mainline (`nginx-mainline`);
# * passenger (`passenger`).
#
# The mainline branch gets new features and bugfixes sooner but might introduce new bugs as well. Critical bugfixes are backported to the stable branch.
#
# In general, the stable release is recommended, but the mainline release is typically quite stable as well.
#
# In addition, Phusion provide packages for NGINX + Passenger (`passenger`).
type Nginx::Package_source = Enum[
'nginx',
'nginx-stable',
'nginx-mainline',
'passenger',
]
Loading