Jira (BOLT-1300) Update install docs to point to puppet-tools repo

27 views
Skip to first unread message

Molly Waggett (JIRA)

unread,
Jul 17, 2019, 7:13:03 PM7/17/19
to puppe...@googlegroups.com
Molly Waggett updated an issue
 
Puppet Task Runner / Improvement BOLT-1300
Update install docs to point to puppet-tools repo
Change By: Molly Waggett
We now have a {{puppet- enterprise- tools}} repo on {yum,apt}.puppet.com that can be used to install Bolt safely without interfering with the {{puppet-agent}} package on a PE-managed node. We currently have a note warning PE users not to setup the repo and to install the packages individually. That workflow means they can't easily upgrade their version of bolt, but it's necessary to avoid accidentally clobbering their puppet-agent with a newer version.

Now that we have the {{puppet-
enterprise- tools}} repo, we can refer PE users to that, so they can get the same benefits of having updates easily available through their package manager.
Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

Molly Waggett (JIRA)

unread,
Jul 17, 2019, 7:13:03 PM7/17/19
to puppe...@googlegroups.com
Molly Waggett updated an issue
Change By: Molly Waggett
Summary: Update install docs to point to puppet- enterprise- tools repo

Molly Waggett (JIRA)

unread,
Jul 17, 2019, 7:20:03 PM7/17/19
to puppe...@googlegroups.com
Molly Waggett commented on Improvement BOLT-1300
 
Re: Update install docs to point to puppet-tools repo

I have puppet-tools packages ready to ship as soon as I get confirmation (perhaps from Jean Bond?) that any existing docs pointing to puppet-enterprise-tools are ready to be changed to puppet-tools.

Nick Walker Garrett Guillotte I'd also love to know if you've already told people about the puppet-enterprise-tools repo. because, if so, you'll need to let them know that it's changing to puppet-tools (though we intend to maintain compatibility with puppet-enterprise-tools for the moment).

Nick Walker (JIRA)

unread,
Jul 17, 2019, 7:49:02 PM7/17/19
to puppe...@googlegroups.com

Garrett Guillotte (JIRA)

unread,
Jul 17, 2019, 7:54:02 PM7/17/19
to puppe...@googlegroups.com

Molly Waggett Per my questions on PE-26104, I was waiting for confirmation about the Bolt docs update before informing customers of a Bolt installation process update, and I was referred to this ticket. I haven't pointed anyone to the PDK doc to resolve the Bolt installation docs discrepancy because that doc does not provide a solution, and after a quick search of support cases I don't see any references to that repo or the PDK docs in question.

My primary concerns haven't changed since April on PE-26104: the Bolt installation docs are dangerous to PE users, some PE customers are navigating past the warning on the page and following the dangerous docs, some customers who do read the warning don't understand the severity of the risks that it suggests and follow the dangerous docs, safe installation docs for Bolt on PE nodes do not exist, and PE docs that reference Bolt installation link to the unsafe docs.

Molly Waggett (JIRA)

unread,
Jul 17, 2019, 8:00:03 PM7/17/19
to puppe...@googlegroups.com

okay, I will ship the puppet-tools release packages tomorrow and then it's just docs changes.

Geoff Nichols (JIRA)

unread,
Jul 18, 2019, 11:16:03 AM7/18/19
to puppe...@googlegroups.com

Michelle Fredette and David Kramer - any chance you could help Kami Olszewski with an update re: timeline to expect public docs updates? 

Michelle Fredette (JIRA)

unread,
Jul 18, 2019, 1:47:03 PM7/18/19
to puppe...@googlegroups.com

Kami Olszewski - I'll try to have this change in by end of day today.

Molly Waggett (JIRA)

unread,
Jul 18, 2019, 4:09:06 PM7/18/19
to puppe...@googlegroups.com

puppet-tools release packages have been shipped

Michelle Fredette (JIRA)

unread,
Jul 18, 2019, 7:40:03 PM7/18/19
to puppe...@googlegroups.com

Kami Olszewski - docs are building. I'll double check that the changes are present later on.

Jean Bond (JIRA)

unread,
Jul 18, 2019, 8:18:03 PM7/18/19
to puppe...@googlegroups.com
Jean Bond commented on Improvement BOLT-1300

PDK docs have been updated and the "enterprise tools" repository information has been removed from the PE docs. Docs are being built now, and the updates should be live within the hour.

Garrett Guillotte (JIRA)

unread,
Jul 19, 2019, 8:31:03 PM7/19/19
to puppe...@googlegroups.com

Thanks Jean Bond and Molly Waggett! I see the docs changes on the Bolt installation docs. These changes include safer instructions for installing the puppet-tools repository instead of the open source Puppet platform repo, and strengthening the language of the warning in the parent topic overview about dangerous platform repos.

Kami Olszewski, now that we have safe Bolt install docs for PE users, I think the next step should be to add a KB article with instructions for detecting and undoing the platform repo installations, targeted at users who've already followed the old instructions but have not yet upgraded OS packages to trigger downtime, and to also call it out it in the next support newsletter that goes out to customers. I've filed SUP-1282 for us to take on that task.

Garrett Guillotte (JIRA)

unread,
Aug 16, 2019, 1:19:03 PM8/16/19
to puppe...@googlegroups.com

The KB article in SUP-1282 is live pending additional review.

Jean Bond I'm not sure what further review is necessary. The docs end of this appears to be addressed. If there's anything else required from Support on this, please let us know.

Jean Bond (JIRA)

unread,
Aug 16, 2019, 1:33:03 PM8/16/19
to puppe...@googlegroups.com
Jean Bond commented on Improvement BOLT-1300

From a docs perspective, this ticket is done and could be resolved.

Garrett Guillotte (JIRA)

unread,
Sep 18, 2019, 8:14:03 PM9/18/19
to puppe...@googlegroups.com
Reply all
Reply to author
Forward
0 new messages