Jira (PUP-9251) Deprecate 'application orchestration' features

39 views
Skip to first unread message

Henrik Lindberg (JIRA)

unread,
Oct 19, 2018, 6:06:02 AM10/19/18
to puppe...@googlegroups.com
Henrik Lindberg created an issue
 
Puppet / Improvement PUP-9251
Deprecate 'application orchestration' features
Issue Type: Improvement Improvement
Assignee: Unassigned
Created: 2018/10/19 3:05 AM
Priority: Normal Normal
Reporter: Henrik Lindberg

We should deprecate the 'application orchestration' features in the puppet language. This means the use of keywords site, application, consumes, and produces should be flagged as deprecated.

Deprecation also needs to be marked in documentation and in specifications. The documentation is here: https://puppet.com/docs/pe/2017.3/managing_applications.html. When doing this work, please also add the tickets for documentation and specification deprecations.

The intent is to remove these features in Puppet 7.0.0.

Deprecation is easy as it can be done during validation of the parsed result. Removal is a bit more involved as there is a separate "site catalog compiler" and related features to remove. When spending time on the deprecation it is worth also writing the tickets for the removal.
Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

Henrik Lindberg (JIRA)

unread,
Oct 19, 2018, 6:06:03 AM10/19/18
to puppe...@googlegroups.com
Henrik Lindberg assigned an issue to Eric Sorenson
Change By: Henrik Lindberg
Assignee: Eric Sorenson

Henrik Lindberg (JIRA)

unread,
Oct 19, 2018, 6:09:03 AM10/19/18
to puppe...@googlegroups.com
Henrik Lindberg commented on Improvement PUP-9251
 
Re: Deprecate 'application orchestration' features

Eric Sorenson Took the liberty of adding this ticket based on your comment in Slack the other day about "lets get rid of this..."

Henrik Lindberg (JIRA)

unread,
Jan 7, 2019, 7:28:03 AM1/7/19
to puppe...@googlegroups.com

I created a PR with the deprecation. If a decision is made (ping Eric Sorenson, Eric Sorenson - which on is the real Eric S at Puppet?) to go ahead with this deprecation the PR needs to be updated with a URL that points to a deprecation documentation page.

Josh Cooper (JIRA)

unread,
Mar 29, 2019, 6:11:04 PM3/29/19
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Team: Coremunity

Josh Cooper (Jira)

unread,
Apr 24, 2020, 8:20:03 PM4/24/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Sprint: Coremunity Hopper
This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)
Atlassian logo

Josh Cooper (Jira)

unread,
Apr 24, 2020, 8:25:03 PM4/24/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Fix Version/s: PUP 6.16.0

Josh Cooper (Jira)

unread,
Apr 24, 2020, 8:26:03 PM4/24/20
to puppe...@googlegroups.com
Josh Cooper assigned an issue to Unassigned
Change By: Josh Cooper
Assignee: Eric Sorenson

Claire Cadman (Jira)

unread,
Apr 29, 2020, 11:47:03 AM4/29/20
to puppe...@googlegroups.com
Claire Cadman commented on Improvement PUP-9251

Josh Cooper Actually the 2018.1 docs will stay on the site and have a stable link. We've started archiving old docs, but they keep the same URL:

https://puppet.com/docs/pe/latest/archived_pe_docs.html

Will that work? Even though it will still have a version, the URL won't change.

Claire Cadman (Jira)

unread,
Apr 30, 2020, 12:27:03 PM4/30/20
to puppe...@googlegroups.com
Claire Cadman commented on Improvement PUP-9251

Yep the same will apply to the 5.5.x docs! We will archive them once they are EOL. Here is the deprecated language page by the way - https://puppet.com/docs/puppet/5.5/deprecated_language.html. 

Josh Cooper (Jira)

unread,
Apr 30, 2020, 2:28:03 PM4/30/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Acceptance Criteria: Puppet issues a deprecation warning when using application orchestration constructs site, application, produces and consumes, and the warning links to text in https://puppet.com/docs/puppet/5.5/deprecated_language.html describing the deprecated language features.

Melissa Stone (Jira)

unread,
Apr 30, 2020, 5:43:03 PM4/30/20
to puppe...@googlegroups.com
Melissa Stone commented on Improvement PUP-9251

May also need to include things like the environment REST API, `consumes` keyword, among other things.

This may impact plans in bolt, should discuss with that team.

Also sync with Froyo.

Melissa Stone (Jira)

unread,
May 5, 2020, 12:41:03 PM5/5/20
to puppe...@googlegroups.com
Melissa Stone updated an issue
Change By: Melissa Stone
Sprint: Coremunity Hopper Grooming

Rob Braden (Jira)

unread,
May 15, 2020, 1:27:04 PM5/15/20
to puppe...@googlegroups.com
Rob Braden updated an issue
Change By: Rob Braden
Fix Version/s: PUP 6.16.0
Fix Version/s: PUP 6.y

Josh Cooper (Jira)

unread,
Jun 5, 2020, 6:04:03 PM6/5/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Sprint: Coremunity Grooming Hopper

Josh Cooper (Jira)

unread,
Jun 8, 2020, 3:11:02 PM6/8/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Sprint: Coremunity Hopper Platform Core KANBAN

Josh Cooper (Jira)

unread,
Jun 8, 2020, 3:11:03 PM6/8/20
to puppe...@googlegroups.com
Josh Cooper assigned an issue to Josh Cooper
Change By: Josh Cooper
Assignee: Josh Cooper

Josh Cooper (Jira)

unread,
Jun 9, 2020, 1:06:02 PM6/9/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Fix Version/s: PUP 6.y
Fix Version/s: PUP 6.17.0

Josh Cooper (Jira)

unread,
Jun 10, 2020, 1:19:03 PM6/10/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
We should deprecate the 'application orchestration' features in the puppet language. This means the use of keywords following should be flagged as deprecated:

* Keywords {{site}}, {{application}}, {{consumes}}, and {{produces}} should be flagged as deprecated
* Metaparameters {{export}} and {{consume}}
* {{Puppet::Parser::EnvironmentCompiler}}
* {{Puppet::Parser::Compiler::CatalogValidator::SiteValidator}} & {{Puppet::Parser::Compiler::CatalogValidator::EnvironmentRelationshipValidator}}
* Resource kinds: {{application}}, {{site}}, {{capability_mapping}}
* {{Puppet::Type#is_capability?}} and {{application?}}
* Environment catalog REST API: https://puppet . com/docs/puppet/latest/http_api/http_environment.html

Deprecation also needs to be marked in documentation and in specifications. The documentation is here: https://puppet.com/docs/pe/2017.3/managing_applications.html. When doing this work, please also add the tickets for documentation and specification deprecations.

The intent is to remove these features in Puppet 7.0.0.

Deprecation is easy as it can be done during validation of the parsed result. Removal is a bit more involved as there is a separate "site catalog compiler" and related features to remove. When spending time on the deprecation it is worth also writing the tickets for the removal.

Josh Cooper (Jira)

unread,
Jun 12, 2020, 10:56:02 AM6/12/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Fix Version/s: PUP 5.5.21

Josh Cooper (Jira)

unread,
Jun 12, 2020, 10:56:03 AM6/12/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Component/s: Docs

Josh Cooper (Jira)

unread,
Jun 12, 2020, 10:56:04 AM6/12/20
to puppe...@googlegroups.com
Josh Cooper commented on Improvement PUP-9251

Melissa Amos (Jira)

unread,
Jun 12, 2020, 12:36:03 PM6/12/20
to puppe...@googlegroups.com
Melissa Amos commented on Improvement PUP-9251

Josh Cooper A couple of questions:

  • Are the fix versions on this ticket correct? 5.5.21 and 6.17 don't correspond to any current or upcoming PE versions. (According to PE build info, 2018.1.16 has 5.5.20, and 2019.8 has 6.16.)
  • Are we deprecating app orchestration in 2018.1, or only deprecating the related terminology? It's a little weird that the 2018.1 docs have an end-of-support warning for 2019.0, a later version. If we're essentially backporting the deprecation, I'll update the version in the warning note here.

No separate DOCs ticket is needed on my part. I do wonder if there's a corresponding PE ticket for this, though? Seems like there might be some work on the PE side to implement this deprecation...

The managing applications docs are 404ing in /latest because that feature was removed in a prior version. You have to change /latest to 2019.0 or earlier to see those docs.

Melissa Amos (Jira)

unread,
Jun 12, 2020, 12:37:03 PM6/12/20
to puppe...@googlegroups.com
Melissa Amos updated an issue
Change By: Melissa Amos
Labels: mamos-followup

Josh Cooper (Jira)

unread,
Jun 15, 2020, 2:53:03 PM6/15/20
to puppe...@googlegroups.com
Josh Cooper updated an issue
Change By: Josh Cooper
Release Notes: Deprecation
Release Notes Summary: The application orchestration feature is being deprecated and will be removed in Puppet 7. Puppetserver will emit a deprecation warning if {{site}}, {{produces}} or {{consumes}} keywords are used in puppet manifests. Puppetserver's environment catalog REST API is also deprecated: https://puppet.com/docs/puppet/latest/http_api/http_environment.html. The export and consume metaparameters are also deprecated. https://puppet.com/docs/puppet/latest/metaparameter.html#consume, https://puppet.com/docs/puppet/latest/metaparameter.html#export

Melissa Amos (Jira)

unread,
Jun 15, 2020, 5:20:04 PM6/15/20
to puppe...@googlegroups.com
Melissa Amos commented on Improvement PUP-9251

I created PE-29376 to track updating PE docs in future versions.

Josh Cooper (Jira)

unread,
Jun 16, 2020, 12:35:03 PM6/16/20
to puppe...@googlegroups.com
Josh Cooper commented on Improvement PUP-9251

Merged to 5.5.x in 4f5bd15e77. Passed CI in 285f220b45

Claire Cadman (Jira)

unread,
Jul 7, 2020, 9:53:03 AM7/7/20
to puppe...@googlegroups.com
Claire Cadman updated an issue
Change By: Claire Cadman
Labels: doc_reviewed mamos-followup

Melissa Amos (Jira)

unread,
Jul 16, 2020, 3:35:36 PM7/16/20
to puppe...@googlegroups.com
Melissa Amos updated an issue
Change By: Melissa Amos
Labels: doc_reviewed mamos-followup
Reply all
Reply to author
Forward
0 new messages