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

39 views
Skip to first unread message

Nick Lewis (JIRA)

unread,
May 9, 2019, 2:53:03 PM5/9/19
to puppe...@googlegroups.com
Nick Lewis updated an issue
 
Puppet Task Runner / Improvement BOLT-1300
Update install docs to point to puppet-enterprise-tools repo
Change By: Nick Lewis
Sprint: Bolt Ready for Grooming
Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

Nick Lewis (JIRA)

unread,
May 9, 2019, 2:53:04 PM5/9/19
to puppe...@googlegroups.com
Nick Lewis created an issue
Issue Type: Improvement Improvement
Assignee: Unassigned
Created: 2019/05/09 11:52 AM
Priority: Normal Normal
Reporter: Nick Lewis

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.

Alex Dreyer (JIRA)

unread,
May 15, 2019, 11:18:03 AM5/15/19
to puppe...@googlegroups.com
Alex Dreyer commented on Improvement BOLT-1300
 
Re: Update install docs to point to puppet-enterprise-tools repo

@nick.walker Does this meet your expectations?

Melissa Amos (JIRA)

unread,
May 15, 2019, 1:06:03 PM5/15/19
to puppe...@googlegroups.com
Melissa Amos commented on Improvement BOLT-1300

We've added instructions for enabling the PE tools repo in the installing section of the PE docs:
https://puppet.com/docs/pe/2019.1/enabling_pe_tools_repository.html

I'd like to see us link to this page as needed, rather than recreating these instructions. We can mention enabling the repos as a task prereq, a note, etc.

Feel free to ping me or add me as a PR reviewer for additional guidance or input.

Nick Walker (JIRA)

unread,
May 28, 2019, 1:24:03 PM5/28/19
to puppe...@googlegroups.com
Nick Walker commented on Improvement BOLT-1300

I'm confused. I thought we were going to make a new repo with bolt and pdk in it. Then we were going to update the install instructions for Bolt to always refer to that repo so that PE users couldn't accidentally read instructions for installing that would inevitably break their PE install.

The new repo just upgrades the existing note about how installing the OSS repo might cause you problems to saying we have a defined way for PE users to install but it doesn't really stop a non-attentive users from skipping the "install for PE" section and going to "install on *nix" section and ending up in the same problematic state.

Yasmin Rajabi (JIRA)

unread,
May 28, 2019, 1:33:03 PM5/28/19
to puppe...@googlegroups.com

Alex Dreyer Nick Walker Molly Waggett theres some confusion on what this name should be... I don't think we discussed puppet-enterprise-tools in the meeting?

Molly Waggett (JIRA)

unread,
May 28, 2019, 1:54:03 PM5/28/19
to puppe...@googlegroups.com

Yasmin Rajabi That name was discussed with my team. We thought that it needed to be clear that this repo is intended for PE users, while FOSS users should continue using the puppetN repos. Are there concerns? If we (RE) shouldn't have been the ones to make that name decision, who should have? How should that have gone differently? /cc Rob Braden

Nick Lewis (JIRA)

unread,
May 28, 2019, 2:04:03 PM5/28/19
to puppe...@googlegroups.com
Nick Lewis commented on Improvement BOLT-1300

The name isn't the question. The question is the purpose. Is this repo meant for PE users or is it meant for all users? I think we will eventually need to have two repos, one that is "non-'Puppet platform' packages" and one that is "PE-compatible packages". Should we create the second repo now or when we need it?

This isn't just a new note for the install doc, it's a whole new set of instructions. And if users ignore the "For Puppet Enterprise Users" section, yes they're gonna be broken. That's true of most of our docs pages; if you pick and choose arbitrary instructions to follow from the page, things will break.

Molly Waggett (JIRA)

unread,
May 28, 2019, 2:07:03 PM5/28/19
to puppe...@googlegroups.com

Nick Lewis What are the use-cases for these two repos? I thought this new repo was "non-'Puppet platform' packages, which are also compatible with PE".

Nick Lewis (JIRA)

unread,
May 28, 2019, 2:09:04 PM5/28/19
to puppe...@googlegroups.com
Nick Lewis commented on Improvement BOLT-1300

We may have packages that aren't part of the "Puppet platform" but which are shipped in PE. In that case, we wouldn't want them in the Puppet platform repos and we also wouldn't want them in the puppet-enterprise-tools repo.

Molly Waggett (JIRA)

unread,
May 28, 2019, 2:16:03 PM5/28/19
to puppe...@googlegroups.com

Why wouldn't we want them in puppet-enterprise-tools? I was under the impression that this is EXACTLY where we'd want to put such packages (e.g. cd4pe packages that I hear are coming).

Alex Dreyer (JIRA)

unread,
May 28, 2019, 2:17:03 PM5/28/19
to puppe...@googlegroups.com
Alex Dreyer commented on Improvement BOLT-1300

My understanding from the original meeting was that we wanted a single repo that we could document for all users to prevent PE users from accidentally adding the FOSS puppet platform repo.

Nick Walker (JIRA)

unread,
May 28, 2019, 2:22:04 PM5/28/19
to puppe...@googlegroups.com
Nick Walker commented on Improvement BOLT-1300

Yes, the install instructions should point to the new repo which works for everyone and doesn't break anything for anyone.

We can provide notes for OSS users that if they want a repo with puppet-agent in it as well they can use the existing repo. If that note is ignored it doesn't break anything for anyone. Worst case scenario is that the user would end up with two puppet repos.

Nick Lewis (JIRA)

unread,
May 28, 2019, 2:24:03 PM5/28/19
to puppe...@googlegroups.com
Nick Lewis commented on Improvement BOLT-1300

Molly Waggett Yeah that's where we want cd4pe packages to go, because it's an enterprise-only feature that doesn't ship in PE. But if we ever included a new open source project in the PE tarball (as opposed to a separate download), we wouldn't want it to be in the pe-tools repo. So we would then be forced to put it in the Puppet platform repos instead, where it doesn't belong.

Molly Waggett (JIRA)

unread,
May 28, 2019, 2:31:03 PM5/28/19
to puppe...@googlegroups.com

okay, that sounds like a cross-that-bridge-when-we-get-there scenario to me. I don't see why that couldn't go into the puppet-enterprise-tools repo, but no use arguing about hypotheticals.

Garrett Guillotte (JIRA)

unread,
Jun 10, 2019, 2:41:04 PM6/10/19
to puppe...@googlegroups.com
Garrett Guillotte updated an issue
 
Change By: Garrett Guillotte
Priority: Normal Major

Alex Dreyer (JIRA)

unread,
Jun 21, 2019, 1:20:04 PM6/21/19
to puppe...@googlegroups.com
Alex Dreyer commented on Improvement BOLT-1300
 
Re: Update install docs to point to puppet-enterprise-tools repo

A related problem was reported by Reid Vandewiele who described how users who do not want to add a repository for installing bolt struggle to find the correct package in the tangled mess of directories in yum.puppet.com. We should probably host the new "puppet-tools" repository at a new domain to solve this problem too.

Rob Braden (JIRA)

unread,
Jun 24, 2019, 1:29:03 PM6/24/19
to puppe...@googlegroups.com
Rob Braden commented on Improvement BOLT-1300

We could, similar to PDK, have a page on the web site that links directly to the packages? Would that solve these issues?

https://puppet.com/download-puppet-development-kit

I'm happy to rethink our repos/download infrastructure but I think we should take a wider view.

Alex Dreyer (JIRA)

unread,
Jun 24, 2019, 3:37:03 PM6/24/19
to puppe...@googlegroups.com
Alex Dreyer commented on Improvement BOLT-1300

Rob Braden We really don't want users to remain on older versions of bolt. I don't want to loudly broadcast direct rpm installs since that will make it harder for less sophisticated users to upgrade.

Lucy Wyman (JIRA)

unread,
Jun 25, 2019, 11:42:03 AM6/25/19
to puppe...@googlegroups.com
Lucy Wyman updated an issue
 
Change By: Lucy Wyman
Labels: DOCS

Geoff Nichols (JIRA)

unread,
Jul 11, 2019, 8:30:03 PM7/11/19
to puppe...@googlegroups.com
Geoff Nichols commented on Improvement BOLT-1300
 
Re: Update install docs to point to puppet-enterprise-tools repo

Nick Lewis, Alex Dreyer, Rob Braden, Molly Waggett  - beyond Garrett's recommended documentation update, what are your thoughts on next actions?

/cc Kami Olszewski

Molly Waggett (JIRA)

unread,
Jul 12, 2019, 1:25:04 PM7/12/19
to puppe...@googlegroups.com

I met with Alex Dreyer, Nick Walker, Rob Braden, Jean Bond, and Jesse Scott to discuss this.

I'm currently working on https://tickets.puppetlabs.com/browse/RE-12521, we'll eventually get to https://tickets.puppetlabs.com/browse/RE-12522, and Jean Bond is working on a single set of installation instructions for both FOSS and PE users.

Jean Bond (JIRA)

unread,
Jul 12, 2019, 6:26:04 PM7/12/19
to puppe...@googlegroups.com
Jean Bond commented on Improvement BOLT-1300

Molly Waggett, because there is one repo to rule them all, there should be a single set of instructions for both FOSS and PE.

However, to reiterate the post-meeting email, the docs team is unfortunately not ready to single source the docs for two separate products at this time. I'll fix the PDK docs set and remove the "enterprise repo" docs from PE, but the Bolt team still owns their documentation.

Kami Olszewski (JIRA)

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

Geoff Nichols and David Kramer what is the timeline to expect these changes to the documented instruction to be implemented? My understanding is this was requested months ago and we believe this should be made public asap so other customers do not run into this. 
Reply all
Reply to author
Forward
0 new messages