Code Monkey home page Code Monkey logo

puppet-docs's Introduction

Puppet Docs

Curated documentation and issue tracker for Puppet

Where is everything?

Most of our documentation has been moved out of this repository. This repo contains:

  • Some of our older, unmaintained documentation, which is deprecated and may be removed from this repo without further notice. For archived docs for unmaintained, unsupported versions of Puppet, see the Puppet docs archive.
  • Reference documentation generated from code. This reference documentation is then rendered into HTML and included in the Puppet docs website.
  • The issue tracker, which community members can use to suggest improvements to puppet.com/docs.

As of Puppet 5.5, Puppet docs were migrated into the DITA XML format and have been maintained in a CMS. We removed each migrated page from this repository, so that the old content wasn't accidentally published.

As of Facter 3.12, the Facter docs were migrated to DITA and organized as part of the Puppet doc set. Updates to 3.12 (and later) should be made in DITA, not in this repo. The generated core_facts.md file is still this repository, but has moved to the puppet/x.y folder instead of facter/x.y.

Reporting issues

Community members can use this repository to suggest documentation improvements. The Technical Publications team regularly monitors and triages issues and requests here. Planning and roadmap activity takes place internally, so you might not see much activity until a writer begins actively working on a reported issue.

๐Ÿ’ก Restriction: There are no SLA agreements for issues filed in this way, and customer reports take priority. If you have a support contract, you should raise issues via support request to get them resolved expediently.

๐Ÿ’ก Restriction: As this is a public repo, avoid including any confidential or sensitive information in issues filed.

  1. To get started, use the Issues tab above.
  2. Search the existing queue to see if your concern has already been reported:
    • If the concern was reported, you can comment on it with additional information or react with a ๐Ÿ‘ to add your support. Youโ€™ll get any future notifications of activity on that ticket.
    • If the concern was not reported, you can file your own issue, following the issue template to include as much helpful detail as you can. Include the full URL of the documentation webpage.

Thank you so much for helping us improve our products! Email [email protected] if you have questions about contributing to the documentation.

Copyright

Copyright (c) 2009-2024 Puppet, Inc. See LICENSE for details.

puppet-docs's People

Contributors

2is3 avatar binford2k avatar blkperl avatar clairecadman avatar cprice404 avatar dependabot[bot] avatar gguillotte avatar ghoneycutt avatar haus avatar hestonhoffman avatar hlindberg avatar ipeldridge avatar jamtur01 avatar joshcooper avatar jtappa avatar juxtin avatar katelopresti avatar kbarber avatar larissalane avatar mfredette avatar mikeyp avatar misseuropa avatar mmclpuppet avatar ncorrare avatar nfagerlund avatar psoloway avatar rooneyshuman avatar sharpie avatar stahnma avatar wkalt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

puppet-docs's Issues

simple test

this will be migrated to Jira by applying a label

Server package requirements are out of date

https://www.puppet.com/docs/pe/2023.6/supported_operating_systems#supported_operating_systems has some kind of extensive package requirements for various operating systems. However, these lists have not been vetted against different OS versions (for example RHEL 7, 8 and 9) to determine if they are still valid. I noticed while testing against EL8 and EL9 systems some of these packages no longer exist and therefore aren't requirements. These lists should be cleaned up and presented as a table for each OS, something like:

Package|. EL7. | EL8 | EL9 |
|Primary|All Nodes|Primary|All Nodes|Primary|All Nodes|
pkgfor7 |. X. |. X. |. |. |. |. |
pkgfor78|. X. | X. | X. |. X. | | |
pkg7-9. |. X | X | X | X | X | X |

Puppet Agent compatibility matrix is wrong / misses information

Describe the Bug

https://www.puppet.com/docs/puppet/8/primary_agent_compatibility says agent 7 works only on puppetserver 7 and agent 8 only on puppetserver 8. I did some internal testing for PE customers and Agent 7 and 8 worked without issues on puppetserver 6/7/8. Can you please update the table or list which components aren't compatible?

Expected Behavior

a compatibility matrix that tells me why something isn't compatible.

Steps to Reproduce

Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'

Environment

  • Version [e.g. 1.27.0]
  • Platform [e.g. Ubuntu 18.04]

Additional Context

Add any other context about the problem here.

Hardware requirements for cloud may be out of date

https://www.puppet.com/docs/pe/2023.6/hardware_requirements#hardware_requirements gives EC2 instance suggestions for large and XL environments. The EC2 suggestions appear to be out of date (they reference 5 series processors when 6 series processors are available with better price/performance), so wondering if we really should have those in the standard documentation to begin with. Would it maybe be better to move instance suggestions to the AWS reference architecture in "Patterns and Tactics"?

Update supported agent platforms for puppet 7 and 8

Please update the supported agent platforms for puppet 7 and 8

Puppet 7

https://www.puppet.com/docs/puppet/7/system_requirements#supported_operating_systems-packaged-platforms

Add

  • Debian 12 (x86_64)
  • Debian 12 (ARM)
  • Red Hat Enterprise Linux 6 (i386)
  • Red Hat Enterprise Linux 6 (x86_64)
  • Red Hat Enterprise Linux 7 (x86_64)
  • Red Hat Enterprise Linux 8 (x86_64)
  • Red Hat Enterprise Linux 8 (ppc64le)

Modify

  • Red Hat Enterprise Linux 9 (x86_64) currently it just says 9 without an architecture

Remove

  • Ubuntu 24.04 (x86_64) (This won't be available until July)
  • Red Hat Enterprise Linux 9 FIPS (that is PE only)

Puppet 8

https://www.puppet.com/docs/puppet/8/system_requirements#supported_operating_systems-packaged-platforms

Add

  • Red Hat Enterprise Linux 7 (x86_64)
  • Red Hat Enterprise Linux 8 (x86_64)
  • Red Hat Enterprise Linux 8 (ppc64le)

Modify

  • Debian 12 aarch64 and ARM different names for the same architecture. I think Debian prefers the aarch64 naming convention
  • macOS 14 x86_64 and Intel are different names for the same architecture. Please drop the Intel variation.
  • Red Hat Enterprise Linux 9 (x86_64) currently it just says 9 without an architecture
  • Ubuntu 20.04 AARCH and 22.04 ARM64 should be aarch64

Remove

  • Ubuntu 24.04 (x86_64) (This won't be available until July)
  • Red Hat Enterprise Linux 9 FIPS (that is PE only)

Custom facts examples use legacy facts

One of the examples in https://www.puppet.com/docs/puppet/8/fact_overview.html#writing_facts_simple_resolutions-examples refers to osfamily, a legacy fact. The sample code should be changed from

Facter.add(:rubypath) do
  setcode 'which ruby'
end

Facter.add(:rubypath) do
  confine osfamily: "Windows"
  # Windows uses 'where' instead of 'which'
  setcode 'where ruby'
end

to something like

Facter.add(:rubypath) do
  setcode 'which ruby'
end

Facter.add(:rubypath) do
  confine 'os' do |os_fact|
    os_fact['family'] == "Windows"
  end
  # Windows uses 'where' instead of 'which'
  setcode 'where ruby'
end

PE Server install page changes

https://www.puppet.com/docs/pe/2023.6/install-pe-using-installer-tarball

Section 1 (Verify the installation package) starts with "These steps are only required if your organization requires you to verify authenticity before installing packages." However, the very first step is to download the installation package (the tar file from the PE download site). Either this section should be retitled "Obtain and verify the installation package" and the first sentence should be moved to the verification steps, or there should be two sections - "Obtain the installation package" and "Verify the installation package". If this is done, the duplicated instructions under "Install from tarball" can be removed to reduce confusion.

The wget and curl examples should state that quotes are required if using the puppet.com download.cgi links.

In the "Install from tarball" section, the tar command needs to have -z included for installation packages downloaded from the puppet.com download.cgi links, since the files are stored in gzip format.

puppetserver 7.15.0, 7.14.0 & 7.12.0 docs are missing

Describe the Bug

https://www.puppet.com/docs/puppet/7/server/release_notes.html doesn't list changes for 7.15.0, 7.14.0 & 7.12.0

Expected Behavior

I expect a detailed changelog, if possible with linked github/public jira tickets. Instead 7.15.0 is missing completely, and 7.14.0/7.12.0 have no information at all.

Steps to Reproduce

Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'

Environment

  • Version [e.g. 1.27.0]
  • Platform [e.g. Ubuntu 18.04]

Additional Context

Add any other context about the problem here.

Postgresql database, 'puppetdb' doesn't yet exist when issuing psql command

In PuppetDB setup for Postgresql, the database, 'puppetdb' doesn't yet exist when issuing the command:

psql puppetdb -c 'grant puppetdb_read to puppetdb'

The createdb command should precede the psql command:

sudo -u postgres sh
createuser -DRSP puppetdb
createuser -DRSP puppetdb_read
# For coordinating partition cleanup
psql puppetdb -c 'grant puppetdb_read to puppetdb'

createdb -E UTF8 -O postgres puppetdb
psql puppetdb -c 'revoke create on schema public from public'
psql puppetdb -c 'grant create on schema public to puppetdb'
psql puppetdb -c 'alter default privileges for user puppetdb in schema public grant select on tables to puppetdb_read'
psql puppetdb -c 'alter default privileges for user puppetdb in schema public grant usage on sequences to puppetdb_read'
psql puppetdb -c 'alter default privileges for user puppetdb in schema public grant execute on functions to puppetdb_read'

Wrong example output for literal function

Describe the Bug

The output of https://www.puppet.com/docs/puppet/7/hiera_merging#interpolation_functions-literal-function is wrong, literal won't add { nor }.

Specifically, it's this sentence:

The value of server_name_string would be %{SERVER_NAME}

The docs should say %SERVER_NAME without the braces.

Expected Behavior

Steps to Reproduce

hiera:

server_name_string: "%{literal('%SERVER_NAME')}"

Puppet:

echo { 'server_name_string:':
  message  => lookup('server_name_string'),
  withpath => false,
}

Outut:

# puppet agent -t --noop
Info: Refreshing CA certificate
Info: CA certificate is unmodified, using existing CA certificate
Info: Refreshing CRL
Info: CRL is unmodified, using existing CRL
Info: Using environment 'production'
Info: Retrieving pluginfacts
Info: Retrieving plugin
Info: Loading facts
Notice: Catalog compiled by puppet.local
Notice: %SERVER_NAME

Environment

root@puppet ~ # dpkg -l | grep puppet
ii  puppet-agent                           8.4.0-1focal                      amd64        The Puppet Agent package contains all of the elements needed to run puppet, including ruby and facter.
ii  puppet-agent-oauth                     0.5.5-1                           all          OAuth Core Ruby implementation for Puppet Agent
ii  puppet8-release                        1.0.0-3focal                      all          Release packages for the Puppet 8 repository
ii  puppetdb                               8.4.1-1focal                      all          Puppet Labs puppetdb
ii  puppetdb-termini                       8.4.1-1focal                      all          Termini for puppetdb
ii  puppetserver                           8.4.0-1focal                      all          Puppet Labs puppetserver
ii  ruby-foreman-puppet                    5.1.2-1                           all          Foreman Puppet Plugin
ii  ruby-puppetdb-foreman                  6.0.2-1                           all          Foreman Puppetdb Plugin
root@puppet ~ #

Additional Context

Add any other context about the problem here.

puppet 8 release notes have missing/incorrect jira links

The puppet 8 changelog has some incorrect links. For example here:
https://www.puppet.com/docs/puppet/8/release_notes_puppet#enhancements_puppet_x-8-3-0-PUP-11429
...the jira link is:
https://perforce.atlassian.net/browse/PUP-11429
...but should be:
https://puppet.atlassian.net/browse/PUP-11429

More recent entries have no links at all for jira issue numbers. For example here:
https://www.puppet.com/docs/puppet/8/release_notes_puppet#resolved_issues_puppet_x-8-5-1-PUP-11985

Thanks,
Corey

Update Puppet Server Java requirements documentation

I think Java requirements documentation needs to be updated. On "Installing Puppet Server" for 7.29.1, it says that Java 8 is still supported.

https://www.puppet.com/docs/puppet/7/server/install_from_packages

On an Amazon Linux 2 server with Java 8 (java-1.8.0-openjdk-headless.x86_64 / 1:1.8.0.402.b06-1.amzn2.0.1):

After I upgraded puppetserver from 7.14 to 7.16 and puppetdb from 7.15 to 7.17, puppetdb kept crashing:

Requesting shutdown: java.lang.NoSuchMethodError: java.nio.ByteBuffer.position(I)Ljava/nio/ByteBuffer

It seems that Puppet is recently taking advantage of something not present in Java 8 (some method existed at compile time but is not present for the runtime).

Upgrading the server to Java 17 resolved the issue (java-17-amazon-corretto-headless.x86_64).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.