diff --git a/_data/nav/openvox_8x.yml b/_data/nav/openvox_8x.yml index 71dc42e00..088085806 100644 --- a/_data/nav/openvox_8x.yml +++ b/_data/nav/openvox_8x.yml @@ -19,20 +19,6 @@ link: "quick_start_sudo.html" - text: Firewall quick start guide link: "quick_start_firewall.html" -- text: Deprecated features - items: - - text: About deprecations in this version - link: "deprecated_summary.html" - - text: Web servers - link: "deprecated_servers.html" - - text: Upcoming operating system deprecations - link: "deprecated_operating_systems.html" - - text: Language features - link: "deprecated_language.html" - - text: Extension points and APIs - link: "deprecated_api.html" - - text: Settings - link: "deprecated_settings.html" - text: Installing and upgrading items: - text: Overview of OpenVox's architecture diff --git a/docs/_openvox_8x/deprecated_api.markdown b/docs/_openvox_8x/deprecated_api.markdown deleted file mode 100644 index 659af56b0..000000000 --- a/docs/_openvox_8x/deprecated_api.markdown +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: "Deprecated extension points and APIs" ---- - -These APIs and extension points are deprecated, and will be removed in future releases. - -{:.section} -## Puppet Faces is a private API - -The `Puppet::Face` and `Puppet::Indirector::Face` classes are private APIs, and we don't document or support them. Don't use them. Instead, to develop command line applications that use Puppet's data: - -* Pick a popular, well-maintained Ruby framework for CLI apps, such as Thor or Commander. -* Use Puppet's public Ruby APIs to access its settings and data. See the [developer documentation](./yard/frames.html) for information about the classes and methods available for this. -* Distribute your application as a Gem or native package, instead of as a Puppet module. -* To make your command available as a `puppet `-style subcommand, name it `puppet-` and put it in your `$PATH`. When you call it, you can leave out the hyphen. - -{:.section} -## Resource type and provider APIs - -As of Puppet 5.0, the [`resource_types` API endpoint](./http_api/http_resource_type.html) has been removed. Instead, use Puppet Server's [`environment_classes` endpoint]({{puppetserver}}/puppet-api/v3/environment_classes.html). - -The `Puppet.newtype` method on the top-level `Puppet` module is a proxy for `Puppet::Type.newtype`. The `Puppet.newtype` method will be removed in a future release. Update any custom resource types to use `Puppet::Type.newtype` instead. - -{:.section} -## Miscellaneous APIs - -The `Puppet::Node::Facts#strip_internal` method has been removed as of Puppet 5.0. - -Previously, the `stacktrace` property in HTTP error responses was always empty for security reasons. In Puppet 5, we've removed the `stacktrace` property as it serves no purpose. \ No newline at end of file diff --git a/docs/_openvox_8x/deprecated_command.markdown b/docs/_openvox_8x/deprecated_command.markdown deleted file mode 100644 index 397906812..000000000 --- a/docs/_openvox_8x/deprecated_command.markdown +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: default -title: "Deprecated command line features" ---- - - -These features of Puppet's command line interface are deprecated in this version of Puppet: - -* The system now behaves as if the setting `--trusted_server_facts` is always set to true, and the setting itself is deprecated but is still present; this to avoid errors for users having set it to true (which is now the default). \ No newline at end of file diff --git a/docs/_openvox_8x/deprecated_language.markdown b/docs/_openvox_8x/deprecated_language.markdown deleted file mode 100644 index 28e2f60c2..000000000 --- a/docs/_openvox_8x/deprecated_language.markdown +++ /dev/null @@ -1,101 +0,0 @@ ---- -layout: default -title: "Deprecated language features" ---- - -These features of the Puppet language are deprecated in this version of Puppet. - -## Hiera 3.x features - -[hiera_functions]: ./hiera_use_hiera_functions.html -[v3]: ./hiera_config_yaml_3.html -[v4]: ./hiera_config_yaml_4.html -[v5]: ./hiera_config_yaml_5.html -[custom_backend]: ./hiera_custom_backends.html -[merging]: ./hiera_merging.html -[module layer]: ./hiera_layers.html#the-module-layer -[lookup_function]: ./hiera_migrate_functions.html -[lookup_command]: ./man/lookup.html -[backend_3]: {{hiera}}/custom_backends.html - -These Hiera features are deprecated, because we replaced them with improved equivalents in [Hiera 5](./hiera_intro.html). - -Old feature | Replacement -------------|------------ -The [classic `hiera_*` functions][hiera_functions]. | [The `lookup` function][lookup_function]. -The `hiera` command line tool. | [The `puppet lookup` command][lookup_command]. -[Version 3][v3] and [version 4][v4] of the hiera.yaml file. | [Version 5][v5]. -[Hiera 3 custom backends][backend_3]. | [Hiera 5 custom backends][custom_backend]. -Setting a global hash merge behavior in hiera.yaml. | [Per-key and per-lookup merge behavior][merging]. -The `calling_module`, `calling_class`, and `calling_class_path` pseudo-variables. | [The module data layer][module layer]. - -## Non-strict variables - -By default, you can access the value of a variable that was never assigned. The value of an unassigned variable is `undef`. - -If you set the `strict_variables` setting to `true`, Puppet raises an error if you try to access an unassigned variable. - -**To update:** Enable `strict_variables` on your Puppet master, run as normal, and look for compilation errors. - -## Automatic symbolic links for `ensure` values in `file` resources - -Puppet doesn't validate the value of the [`ensure` attribute in `file` resources](/puppet/latest/type.html#file-attribute-ensure). If the value is not `present`, `absent`, `file`, `directory`, or `link`, Puppet treats the value as an arbitrary path and creates a symbolic link to that path. - -For example, these resource declarations are equivalent: - -``` puppet -file { "/etc/inetd.conf": - ensure => link, - target => "/etc/inet/inetd.conf", -} - -file { "/etc/inetd.conf": - ensure => "/etc/inet/inetd.conf", -} -``` - -However, syntax errors in the `ensure` attribute's value can lead to unexpected behaviors. For instance, mistyping a value can lead Puppet to create a symbolic link that treats the typo as the link's target: - -``` puppet -file { "/etc/inetd.conf": - ensure => filer, -} -``` - -The above example results in Puppet creating a symbolic link at `/etc/inetd.conf` that points to `filer`---it doesn't throw an error or produce a warning. - -``` bash -$ sudo /opt/puppetlabs/bin/puppet apply -e 'file { "/etc/inetd.conf": ensure => filer}' -Notice: Compiled catalog for master.example.com in environment production in 1.18 seconds -Notice: /Stage[main]/Main/File[/etc/filer]/ensure: created -Notice: Applied catalog in 0.49 seconds - -$ sudo ls -la /etc/inetd.conf -lrwxrwxrwx 1 root root 10 Nov 9 20:53 /etc/inetd.conf -> filer -``` - -**To update:** Confirm that the `ensure` attribute of your `file` resources has one of its allowed values. If you rely on this implicit symlinking behavior, change the value of `ensure` to `link` and add a `target` attribute that contains the target path as its value. - -Likewise, using the `source` parameter with `ensure => link` can result in unexpected behavior, depending on the content of the `source` parameter's value. The result of this example is a regular file --- not a symlink --- being created at `/etc/inetd.conf` with the copied contents of `/tmp/inetd.conf`: - -``` puppet -file { "/etc/inetd.conf": - ensure => link, - links => manage, - source => "file:///tmp/inetd.conf", -} -``` - -Alternatively, this example creates a broken symlink --- not a file --- to whatever path `inetd_file` points to on the Puppet master, but only if a file doesn't exist at the same path on the agent: - -``` puppet -file { "/etc/inetd.conf": - ensure => link, - links => manage, - source => 'puppet:///modules/inetd/inetd_file', -} -``` - -These behaviors should not be allowed; `ensure => link` and `source` should be mutually exclusive. - -For details and examples of more deprecated symlink behavior, see JIRA ticket [PUP-5830](https://tickets.puppetlabs.com/browse/PUP-5830). diff --git a/docs/_openvox_8x/deprecated_misc.markdown b/docs/_openvox_8x/deprecated_misc.markdown deleted file mode 100644 index 8ac6b4005..000000000 --- a/docs/_openvox_8x/deprecated_misc.markdown +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: default -title: "Other deprecated features" ---- - - -These miscellaneous features are deprecated in this version of Puppet: - -* The `external_facts` feature is deprecated as the version of Facter Puppet depends on now always includes this functionality. \ No newline at end of file diff --git a/docs/_openvox_8x/deprecated_operating_systems.md b/docs/_openvox_8x/deprecated_operating_systems.md deleted file mode 100644 index e3b0a5dff..000000000 --- a/docs/_openvox_8x/deprecated_operating_systems.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: default -title: "Upcoming operating system deprecations" -toc: false ---- - -Open source Puppet ships `puppet-agent` packages for a variety of platforms, but some systems have been deprecated since we began shipping them, and we will no longer be providing packages for those systems. - -The [system requirements](./system_requirements.html) lists which platforms we currently publish packages for. Watch this space for upcoming deprecations in Puppet 5. - diff --git a/docs/_openvox_8x/deprecated_resource.markdown b/docs/_openvox_8x/deprecated_resource.markdown deleted file mode 100644 index af2051736..000000000 --- a/docs/_openvox_8x/deprecated_resource.markdown +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: default -title: "Deprecated resource type features" ---- - - -These features of Puppet's built-in resource types are deprecated in this version of Puppet. - -* Previously, if a class was defined more than once their bodies would be merged. The output of a warning or error was under the control of the `--strict` flag. Now, this is always an error except for the top scope class named '' (also known as 'main'). \ No newline at end of file diff --git a/docs/_openvox_8x/deprecated_servers.md b/docs/_openvox_8x/deprecated_servers.md deleted file mode 100644 index 07dc72980..000000000 --- a/docs/_openvox_8x/deprecated_servers.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: "Deprecated web servers" ---- - -Rack and WEBrick masters are deprecated in this version of Puppet. You should instead use Puppet Server. - diff --git a/docs/_openvox_8x/deprecated_settings.markdown b/docs/_openvox_8x/deprecated_settings.markdown deleted file mode 100644 index 0369dd54e..000000000 --- a/docs/_openvox_8x/deprecated_settings.markdown +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -title: "Deprecated settings" ---- - -These Puppet settings are deprecated in this version of Puppet: diff --git a/docs/_openvox_8x/deprecated_summary.markdown b/docs/_openvox_8x/deprecated_summary.markdown deleted file mode 100644 index b224480d7..000000000 --- a/docs/_openvox_8x/deprecated_summary.markdown +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: "About deprecations in this version of Puppet" ---- - -The 4.x deprecations focused on Puppet's infrastructure, and APIs, many of these have been removed in Puppet 5. - -You should read through the removals in [Puppet 5 release notes](./release_notes.html#removals) to make sure they won't break your setup before upgrading. - -Each deprecation page groups similar features together, and each feature explains what to do if you're affected. -