diff --git a/guides/common/assembly_managing-content-views.adoc b/guides/common/assembly_managing-content-views.adoc index 08ab173526d..9740e6422fd 100644 --- a/guides/common/assembly_managing-content-views.adoc +++ b/guides/common/assembly_managing-content-views.adoc @@ -8,25 +8,41 @@ include::modules/ref_best-practices-for-content-views.adoc[leveloffset=+1] include::modules/ref_best-practices-for-patching-content-hosts.adoc[leveloffset=+1] -include::modules/proc_creating-a-content-view.adoc[leveloffset=+1] +include::modules/proc_creating-a-content-view-by-using-web-ui.adoc[leveloffset=+1] -include::modules/proc_copying-a-content-view.adoc[leveloffset=+1] +include::modules/proc_creating-a-content-view-by-using-cli.adoc[leveloffset=+1] + +include::modules/proc_copying-a-content-view-by-using-web-ui.adoc[leveloffset=+1] + +include::modules/proc_copying-a-content-view-by-using-cli.adoc[leveloffset=+1] include::modules/proc_synchronizing-a-content-view-to-a-smart-proxy-server.adoc[leveloffset=+1] -include::modules/proc_viewing-module-streams.adoc[leveloffset=+1] +include::modules/proc_viewing-module-streams-by-using-web-ui.adoc[leveloffset=+1] + +include::modules/proc_viewing-module-streams-by-using-cli.adoc[leveloffset=+1] + +include::modules/proc_promoting-a-content-view-by-using-web-ui.adoc[leveloffset=+1] -include::modules/proc_promoting-a-content-view.adoc[leveloffset=+1] +include::modules/proc_promoting-a-content-view-by-using-cli.adoc[leveloffset=+1] + +include::modules/proc_promoting-a-content-view-to-all-environments-in-an-organization.adoc[leveloffset=+1] include::modules/con_rolling-content-views.adoc[leveloffset=+1] -include::modules/proc_creating-a-rolling-content-view.adoc[leveloffset=+1] +include::modules/proc_creating-a-rolling-content-view-by-using-web-ui.adoc[leveloffset=+1] + +include::modules/proc_creating-a-rolling-content-view-by-using-cli.adoc[leveloffset=+1] -include::modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments.adoc[leveloffset=+1] +include::modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-web-ui.adoc[leveloffset=+1] + +include::modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-cli.adoc[leveloffset=+1] include::modules/con_composite-content-views-overview.adoc[leveloffset=+1] -include::modules/proc_creating-a-composite-content-view.adoc[leveloffset=+1] +include::modules/proc_creating-a-composite-content-view-by-using-web-ui.adoc[leveloffset=+1] + +include::modules/proc_creating-a-composite-content-view-by-using-cli.adoc[leveloffset=+1] include::modules/con_content-filter-overview.adoc[leveloffset=+1] diff --git a/guides/common/modules/con_clearing-the-search-filter.adoc b/guides/common/modules/con_clearing-the-search-filter.adoc index 9b8dbb9440b..7ac908f7735 100644 --- a/guides/common/modules/con_clearing-the-search-filter.adoc +++ b/guides/common/modules/con_clearing-the-search-filter.adoc @@ -3,6 +3,7 @@ [id="Clearing_the_Search_Filter_{context}"] = Clearing the search filter +[role="_abstract"] If you search for specific content types by using keywords in the *Search* text box and the search returns no results, click *Clear search* to clear all the search queries and reset the *Search* text box. If you use a filter to search for specific repositories in the *Type* text box and the search returns no results, click *Clear filters* to clear all active filters and reset the *Type* text box. diff --git a/guides/common/modules/con_composite-content-views-overview.adoc b/guides/common/modules/con_composite-content-views-overview.adoc index 01e07f10194..6446d57320a 100644 --- a/guides/common/modules/con_composite-content-views-overview.adoc +++ b/guides/common/modules/con_composite-content-views-overview.adoc @@ -3,12 +3,15 @@ [id="Composite_Content_Views_Overview_{context}"] = Composite content views overview +[role="_abstract"] A composite content view combines the content from several content views. For example, you might have separate content views to manage an operating system and an application individually. You can use a composite content view to merge the contents of both content views into a new repository. The repositories for the original content views still exist but a new repository also exists for the combined content. -If you want to develop an application that supports different database servers. +.Application that supports different database servers +==== +You want to develop an application that supports different database servers. The _example_application_ appears as: |=== @@ -47,11 +50,12 @@ Example composite content view for a MariaDB: | MariaDB (Database) | {client-os} (Operating System) |=== +==== Each content view is then managed and published separately. When you create a version of the application, you publish a new version of the composite content views. You can also select the *Auto Publish* option when creating a composite content view, and then the composite content view is automatically republished when a content view it includes is republished. -.Repository restrictions +Repository restrictions:: Docker repositories cannot be included more than once in a composite content view. For example, if you attempt to include two content views that contain the same docker repository in a composite content view, {ProjectServer} reports an error. diff --git a/guides/common/modules/con_content-access-strategies.adoc b/guides/common/modules/con_content-access-strategies.adoc index 233b779b320..80d49c552dd 100644 --- a/guides/common/modules/con_content-access-strategies.adoc +++ b/guides/common/modules/con_content-access-strategies.adoc @@ -44,7 +44,7 @@ For more information about multiple content view environments, see xref:managing Composite content views:: You can use composite content views to combine and give hosts access to the content from multiple content views. -For more information about composite content views, see xref:Creating_a_Composite_Content_View_{context}[]. +For more information about composite content views, see xref:creating-a-composite-content-view-by-using-web-ui[]. Architecture and operating system version restrictions:: In custom products, you can set restrictions on the architecture and operating system versions for `{client-content-type}` repositories on which the product will be available. diff --git a/guides/common/modules/con_content-filter-examples.adoc b/guides/common/modules/con_content-filter-examples.adoc index c4cd9877a21..b5b29bfe11d 100644 --- a/guides/common/modules/con_content-filter-examples.adoc +++ b/guides/common/modules/con_content-filter-examples.adoc @@ -3,6 +3,7 @@ [id="Content_Filter_Examples_{context}"] = Content filter examples +[role="_abstract"] Use any of the following examples with the procedure that follows to build custom content filters. [NOTE] @@ -11,7 +12,8 @@ Filters can significantly increase the time to publish a content view. For example, if a content view publish task completes in a few minutes without filters, it can take 30 minutes after adding an exclude or include errata filter. ==== -.Example 1 +.Include a package group +==== Create a repository with the base {client-os} packages. This filter requires a {client-os} repository added to the content view. @@ -20,8 +22,10 @@ This filter requires a {client-os} repository added to the content view. * *Inclusion Type:* Include * *Content Type:* Package Group * *Filter:* Select only the *Base* package group +==== -.Example 2 +.Exclude errata +==== Create a repository that excludes all errata, except for security updates, after a certain date. This is useful if you want to perform system updates on a regular basis with the exception of critical security updates, which must be applied immediately. This filter requires a {client-os} repository added to the content view. @@ -34,8 +38,10 @@ This filter requires a {client-os} repository added to the content view. Set the *Date Type* to *Updated On*. Set the *Start Date* to the date you want to restrict errata. Leave the *End Date* blank to ensure any new non-security errata is filtered. +==== -.Example 3 +.Exclude errata and include a package group +==== A combination of Example 1 and Example 2 where you only require the operating system packages and want to exclude recent bug fix and enhancement errata. This requires two filters attached to the same content view. The content view processes the Include filter first, then the Exclude filter. @@ -54,9 +60,11 @@ The content view processes the Include filter first, then the Exclude filter. Set the *Date Type* to *Updated On*. Set the *Start Date* to the date you want to restrict errata. Leave the *End Date* blank to ensure any new non-security errata is filtered. +==== ifdef::client-content-dnf[] -.Example 4 +.Include a module stream +==== Filter a specific module stream in a content view. *Filter 1:* @@ -72,8 +80,10 @@ Filter a specific module stream in a content view. * *Filter:* Add a rule to filter any non-modular packages that you want to exclude from the content view. If you do not filter the packages, the content view filter includes all non-modular packages associated with the module stream *ant*. Add a rule to exclude all `*` packages, or specify the package names that you want to exclude. +==== endif::[] ifndef::orcharhino[] -For another example of how content filters work, see the following article: https://access.redhat.com/solutions/1564953["How do content filters work in Satellite 6"]. +.Additional resources +* https://access.redhat.com/solutions/1564953["How do content filters work in Satellite 6"] endif::[] diff --git a/guides/common/modules/con_content-filter-overview.adoc b/guides/common/modules/con_content-filter-overview.adoc index 8f0cc23ed45..d8dac85b4b5 100644 --- a/guides/common/modules/con_content-filter-overview.adoc +++ b/guides/common/modules/con_content-filter-overview.adoc @@ -3,6 +3,7 @@ [id="Content_Filter_Overview_{context}"] = Content filter overview +[role="_abstract"] ifdef::satellite[] Content views also use filters to include or restrict certain Yum content. endif::[] @@ -11,8 +12,9 @@ Content views also use filters to include or restrict certain Deb and Yum conten endif::[] Without these filters, a content view includes everything from the selected repositories. +Filter types:: There are two types of content filters: - ++ .Filter types [cols="1,3"] |=== @@ -25,14 +27,13 @@ Use this filter when you want to use most of a particular content repository whi The filter uses all content in the repository except for the content you select. |=== -.Include and Exclude filter combinations +Include and Exclude filter combinations:: If using a combination of Include and Exclude filters, publishing a content view triggers the include filters first, then the exclude filters. In this situation, select which content to include, then which content to exclude from the inclusive subset. -.Content types - +Content types:: You can filter content based on the following content types: - ++ .Content types [cols="2,3"] |=== diff --git a/guides/common/modules/con_content-promotion-across-the-application-lifecycle.adoc b/guides/common/modules/con_content-promotion-across-the-application-lifecycle.adoc index 1b4da209c0c..7f41dfda9af 100644 --- a/guides/common/modules/con_content-promotion-across-the-application-lifecycle.adoc +++ b/guides/common/modules/con_content-promotion-across-the-application-lifecycle.adoc @@ -70,4 +70,4 @@ After a successful review, promote the package to the _Production_ environment: ==== .Additional resources -* xref:Promoting_a_Content_View_{context}[] +* xref:promoting-a-content-view-by-using-web-ui[] diff --git a/guides/common/modules/con_content-views-in-project.adoc b/guides/common/modules/con_content-views-in-project.adoc index 34a9aa0c87d..88a4098af35 100644 --- a/guides/common/modules/con_content-views-in-project.adoc +++ b/guides/common/modules/con_content-views-in-project.adoc @@ -3,6 +3,7 @@ [id="Content-Views-in-{ProjectNameID}_{context}"] = Content views in {ProjectName} +[role="_abstract"] A content view is a deliberately curated subset of content that your hosts can access. By creating a content view, you can define the software versions used by a particular environment or {SmartProxyServer}. @@ -17,11 +18,11 @@ For example, you can use one content view for content for managing an operating By creating a composite content view that combines both content views, you create a new repository that merges the repositories from each of the content views. However, the repositories for the content views still exist and you can keep managing them separately as well. -.Default Organization View +Default Organization View:: A _Default Organization View_ is an application-controlled content view for all content that is synchronized to {Project}. You can register a host to the _Library_ environment on {Project} to consume the _Default Organization View_ without configuring content views and lifecycle environments. - ifndef::satellite[] ++ You can access unprotected repositories in the _Default Organization View_ content view. The URL consists of your {SmartProxy} FQDN, `/pulp/content/`, your organization label, `/Library/custom/`, your product label, `/`, your repository label, and a trailing `/`, for example, `\https://{foreman-example-com}/pulp/content/Example/Library/custom/{client-content-product-label}/{client-content-repository-label}/`. ifdef::content-management[] @@ -40,7 +41,7 @@ endif::[] endif::[] endif::[] -.Promoting a content view across environments +Promoting a content view across environments:: When you promote a content view from one environment to the next environment in the application lifecycle, {Project} updates the repository and publishes the packages. .Promoting a package from _Development_ to _Testing_ @@ -80,5 +81,5 @@ endif::[] ifeval::["{context}" == "planning"] [role="_additional-resources"] .Additional resources -* For more information, see {ContentManagementDocURL}Managing_Content_Views_content-management[Managing content views] in _{ContentManagementDocTitle}_. +* {ContentManagementDocURL}Managing_Content_Views_content-management[Managing content views in _{ContentManagementDocTitle}_] endif::[] diff --git a/guides/common/modules/con_managing-content-views.adoc b/guides/common/modules/con_managing-content-views.adoc index 6c3027b2db3..101fb2236a0 100644 --- a/guides/common/modules/con_managing-content-views.adoc +++ b/guides/common/modules/con_managing-content-views.adoc @@ -3,6 +3,7 @@ [id="Managing_Content_Views_{context}"] = Managing content views +[role="_abstract"] {ProjectName} uses content views to allow your hosts access to a deliberately curated subset of content. To do this, you must define which repositories to use and then apply certain filters to the content. @@ -16,7 +17,7 @@ For more information, see xref:Content_Filter_Examples_{context}[]. For more information, see xref:Resolving_Package_Dependencies_{context}[]. . Publish the content view. . Optional: Promote the content view to another environment. -For more information, see xref:Promoting_a_Content_View_{context}[]. +For more information, see xref:promoting-a-content-view-by-using-web-ui[]. . Attach the content host to the content view. ifdef::client-content-dnf[] @@ -28,4 +29,4 @@ endif::[] Hosts can only be associated with a single content view. To associate a host with multiple content views, create a composite content view. -For more information, see xref:Creating_a_Composite_Content_View_{context}[]. +For more information, see xref:creating-a-composite-content-view-by-using-web-ui[]. diff --git a/guides/common/modules/con_resolving-package-dependencies.adoc b/guides/common/modules/con_resolving-package-dependencies.adoc index c47f095fda0..9f38537fad7 100644 --- a/guides/common/modules/con_resolving-package-dependencies.adoc +++ b/guides/common/modules/con_resolving-package-dependencies.adoc @@ -3,6 +3,7 @@ [id="Resolving_Package_Dependencies_{context}"] = Resolving package dependencies +[role="_abstract"] {Project} can add dependencies of packages in a content view to the dependent repository when publishing the content view. To configure this, you can enable _dependency solving_. diff --git a/guides/common/modules/con_rolling-content-views.adoc b/guides/common/modules/con_rolling-content-views.adoc index 25fc375a362..b3d409be617 100644 --- a/guides/common/modules/con_rolling-content-views.adoc +++ b/guides/common/modules/con_rolling-content-views.adoc @@ -3,6 +3,7 @@ [id="rolling-content-views"] = Rolling content views +[role="_abstract"] A rolling content view is a curated subset of content that your hosts can access. It is a subset of the Library environment and contains the latest synchronized content from one or multiple repositories. You can use a rolling content view to provide a continuous stream of synchronized content to hosts. diff --git a/guides/common/modules/con_standardizing-content-view-empty-states.adoc b/guides/common/modules/con_standardizing-content-view-empty-states.adoc index 32803bee8ea..74329d880eb 100644 --- a/guides/common/modules/con_standardizing-content-view-empty-states.adoc +++ b/guides/common/modules/con_standardizing-content-view-empty-states.adoc @@ -3,6 +3,7 @@ [id="Standardizing_Content_View_Empty_States_{context}"] = Standardizing content view empty states +[role="_abstract"] If there are no filters listed for a content view, click *Create filter*. A modal opens to show you the next steps to create a filter. Follow these steps to add a new filter to create new content types. diff --git a/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments.adoc b/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-cli.adoc similarity index 68% rename from guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments.adoc rename to guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-cli.adoc index 1a2142ff605..2decfa6125f 100644 --- a/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments.adoc +++ b/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-cli.adoc @@ -1,26 +1,17 @@ :_mod-docs-content-type: PROCEDURE -[id="assigning-a-rolling-content-view-to-lifecycle-environments"] -= Assigning a rolling content view to lifecycle environments +[id="assigning-a-rolling-content-view-to-lifecycle-environments-by-using-cli"] += Assigning a rolling content view to lifecycle environments by using Hammer CLI -You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers}. +[role="_abstract"] +You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using Hammer CLI. To consume rolling content views, you must assign them to one or more lifecycle environments. By doing so, you expose a subset of Library content to those lifecycle environments. {Team} does not recommend assigning a rolling content view to the Library environment itself because it creates duplicate content within Library. By using environments other than Library, you can synchronize your rolling content views from {ProjectServer} to any {SmartProxyServers} that are configured to consume the relevant lifecycle environments without the need to synchronize all of Library to {SmartProxyServers}. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-assigning-a-rolling-content-view-to-lifecycle-environments[]. - .Procedure -. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. -. Select your rolling content view. -. Select the *Details* tab. -. In the *Lifecycle Environments* field, assign your rolling content view to your lifecycle environments. -. Click *Save Environments* to submit your changes to {Project}. - -[id="cli-assigning-a-rolling-content-view-to-lifecycle-environments"] -.CLI procedure . List all content views: + [options="nowrap" subs="+quotes"] diff --git a/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-web-ui.adoc b/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-web-ui.adoc new file mode 100644 index 00000000000..c31deb6db25 --- /dev/null +++ b/guides/common/modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-web-ui.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: PROCEDURE + +[id="assigning-a-rolling-content-view-to-lifecycle-environments-by-using-web-ui"] += Assigning a rolling content view to lifecycle environments by using {ProjectWebUI} + +[role="_abstract"] +You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using {ProjectWebUI}. + +To consume rolling content views, you must assign them to one or more lifecycle environments. +By doing so, you expose a subset of Library content to those lifecycle environments. +{Team} does not recommend assigning a rolling content view to the Library environment itself because it creates duplicate content within Library. +By using environments other than Library, you can synchronize your rolling content views from {ProjectServer} to any {SmartProxyServers} that are configured to consume the relevant lifecycle environments without the need to synchronize all of Library to {SmartProxyServers}. + +.Procedure +. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. +. Select your rolling content view. +. Select the *Details* tab. +. In the *Lifecycle Environments* field, assign your rolling content view to your lifecycle environments. +. Click *Save Environments* to submit your changes to {Project}. + +.Next steps +* Synchronize lifecycle environments to {SmartProxyServers}. +For more information, see {AdministeringDocURL}Synchronizing_Content_from_{project-context}_Server_to_{smart-proxy-context-titlecase}_Servers_admin[Synchronizing content from {ProjectServer} to {SmartProxyServers}] in _{AdministeringDocTitle}_. diff --git a/guides/common/modules/proc_comparing-content-view-versions.adoc b/guides/common/modules/proc_comparing-content-view-versions.adoc index eed34b3d6eb..8f7be96d826 100644 --- a/guides/common/modules/proc_comparing-content-view-versions.adoc +++ b/guides/common/modules/proc_comparing-content-view-versions.adoc @@ -3,6 +3,7 @@ [id="Comparing_Content_View_Versions_{context}"] = Comparing content view versions +[role="_abstract"] Use this procedure to compare content view version functionality for {Project}. .Procedure diff --git a/guides/common/modules/proc_copying-a-content-view-by-using-cli.adoc b/guides/common/modules/proc_copying-a-content-view-by-using-cli.adoc new file mode 100644 index 00000000000..616f3a69f4d --- /dev/null +++ b/guides/common/modules/proc_copying-a-content-view-by-using-cli.adoc @@ -0,0 +1,24 @@ +:_mod-docs-content-type: PROCEDURE + +[id="copying-a-content-view-by-using-cli"] += Copying a content view by using Hammer CLI + +[role="_abstract"] +You can copy an existing content view into a new content view by using Hammer CLI. + +[NOTE] +==== +A copied content view does not have the same history as the original content view. +Version 1 of the copied content view begins at the last version of the original content view. +As a result, you cannot promote an older version of a content view from the copied content view. +==== + +.Procedure +* Copy the content view by using Hammer: ++ +[options="nowrap", subs="+quotes,attributes"] +---- +$ hammer content-view copy \ +--name _My_original_CV_name_ \ +--new-name _My_new_CV_name_ +---- diff --git a/guides/common/modules/proc_copying-a-content-view.adoc b/guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc similarity index 59% rename from guides/common/modules/proc_copying-a-content-view.adoc rename to guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc index cbf6b686b98..c6599d6c168 100644 --- a/guides/common/modules/proc_copying-a-content-view.adoc +++ b/guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: PROCEDURE -[id="Copying_a_Content_View_{context}"] -= Copying a content view +[id="copying-a-content-view-by-using-web-ui"] += Copying a content view by using {ProjectWebUI} -You can copy an existing content view into a new content view. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-copying-a-content-view_{context}[]. +[role="_abstract"] +You can copy an existing content view into a new content view by using {ProjectWebUI}. [NOTE] ==== @@ -21,14 +21,3 @@ As a result, you cannot promote an older version of a content view from the copi .Verification * The copied content view appears on the *Content views* page. - -[id="cli-copying-a-content-view_{context}"] -.CLI procedure -* Copy the content view by using Hammer: -+ -[options="nowrap", subs="+quotes,attributes"] ----- -$ hammer content-view copy \ ---name _My_original_CV_name_ \ ---new-name _My_new_CV_name_ ----- diff --git a/guides/common/modules/proc_creating-a-composite-content-view.adoc b/guides/common/modules/proc_creating-a-composite-content-view-by-using-cli.adoc similarity index 63% rename from guides/common/modules/proc_creating-a-composite-content-view.adoc rename to guides/common/modules/proc_creating-a-composite-content-view-by-using-cli.adoc index 9b49b97a031..c5ee66354b5 100644 --- a/guides/common/modules/proc_creating-a-composite-content-view.adoc +++ b/guides/common/modules/proc_creating-a-composite-content-view-by-using-cli.adoc @@ -1,30 +1,12 @@ :_mod-docs-content-type: PROCEDURE -[id="Creating_a_Composite_Content_View_{context}"] -= Creating a composite content view +[id="creating-a-composite-content-view-by-using-cli"] += Creating a composite content view by using Hammer CLI -Use this procedure to create a composite content view. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-composite-content-view_{context}[]. +[role="_abstract"] +Use this procedure to create a composite content view by using Hammer CLI. .Procedure -. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. -. Click *Create content view*. -. In the *Create content view* window, enter a name for the view in the *Name* field. -{ProjectName} automatically completes the *Label* field from the name you enter. -. Optional: In the *Description* field, enter a description of the view. -. On the *Type* tab, select *Composite content view*. -. Optional: If you want to automatically publish a new version of the composite content view when a content view is republished, select the *Auto publish* checkbox. -. Click *Create content view*. -. On the *Content views* tab, select the content views that you want to add to the composite content view, and then click *Add content views*. -. In the *Add content views* window, select the version of each content view. -. Optional: If you want to automatically update the content view to the latest version, select the *Always update to latest version* checkbox. -. Click *Add*, then click *Publish new version*. -. Optional: In the *Description* field, enter a description of the content view. -. In the *Publish* window, set the *Promote* switch, then select the lifecycle environment. -. Click *Next*, then click *Finish*. - -[id="cli-creating-a-composite-content-view_{context}"] -.CLI procedure . Before you create the composite content views, list the version IDs for your existing content views: + [options="nowrap" subs="+quotes"] diff --git a/guides/common/modules/proc_creating-a-composite-content-view-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-composite-content-view-by-using-web-ui.adoc new file mode 100644 index 00000000000..fe86a376133 --- /dev/null +++ b/guides/common/modules/proc_creating-a-composite-content-view-by-using-web-ui.adoc @@ -0,0 +1,24 @@ +:_mod-docs-content-type: PROCEDURE + +[id="creating-a-composite-content-view-by-using-web-ui"] += Creating a composite content view by using {ProjectWebUI} + +[role="_abstract"] +Use this procedure to create a composite content view by using {ProjectWebUI}. + +.Procedure +. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. +. Click *Create content view*. +. In the *Create content view* window, enter a name for the view in the *Name* field. +{ProjectName} automatically completes the *Label* field from the name you enter. +. Optional: In the *Description* field, enter a description of the view. +. On the *Type* tab, select *Composite content view*. +. Optional: If you want to automatically publish a new version of the composite content view when a content view is republished, select the *Auto publish* checkbox. +. Click *Create content view*. +. On the *Content views* tab, select the content views that you want to add to the composite content view, and then click *Add content views*. +. In the *Add content views* window, select the version of each content view. +. Optional: If you want to automatically update the content view to the latest version, select the *Always update to latest version* checkbox. +. Click *Add*, then click *Publish new version*. +. Optional: In the *Description* field, enter a description of the content view. +. In the *Publish* window, set the *Promote* switch, then select the lifecycle environment. +. Click *Next*, then click *Finish*. diff --git a/guides/common/modules/proc_creating-a-content-view-by-using-cli.adoc b/guides/common/modules/proc_creating-a-content-view-by-using-cli.adoc new file mode 100644 index 00000000000..d787aa014e5 --- /dev/null +++ b/guides/common/modules/proc_creating-a-content-view-by-using-cli.adoc @@ -0,0 +1,48 @@ +:_mod-docs-content-type: PROCEDURE + +[id="creating-a-content-view-by-using-cli"] += Creating a content view by using Hammer CLI + +[role="_abstract"] +Use this procedure to create a content view by using Hammer CLI. + +While you can stipulate whether you want to resolve any package dependencies on a content view by content view basis, you might want to change the default {Project} settings to enable or disable package resolution for all content views. +For more information, see xref:Resolving_Package_Dependencies_{context}[]. + +.Procedure +. Obtain a list of repository IDs: ++ +[options="nowrap", subs="+quotes,verbatim,attributes"] +---- +$ hammer repository list --organization "_My_Organization_" +---- +. Create the content view and add repositories: ++ +[options="nowrap", subs="+quotes,verbatim,attributes"] +---- +$ hammer content-view create \ +--description "_My_Content_View_" \ +--name "_My_Content_View_" \ +--organization "_My_Organization_" \ +--repository-ids _My_Repository_ID_1_,_My_Repository_ID_2_ +---- +. Optional: Add another repository to your content view: ++ +[options="nowrap", subs="+quotes,verbatim,attributes"] +---- +$ hammer content-view add-repository \ +--name "_My_Content_View_" \ +--organization "_My_Organization_" \ +--repository-id _My_Repository_ID_3_ +---- +. Publish the content view: ++ +[options="nowrap", subs="+quotes,verbatim,attributes"] +---- +$ hammer content-view publish \ +--description "_My_Content_View_" \ +--name "_My_Content_View_" \ +--organization "_My_Organization_" +---- ++ +{ProjectServer} creates the new version of the view and publishes it to the Library environment. diff --git a/guides/common/modules/proc_creating-a-content-view-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-content-view-by-using-web-ui.adoc new file mode 100644 index 00000000000..764a9868a15 --- /dev/null +++ b/guides/common/modules/proc_creating-a-content-view-by-using-web-ui.adoc @@ -0,0 +1,31 @@ +:_mod-docs-content-type: PROCEDURE + +[id="creating-a-content-view-by-using-web-ui"] += Creating a content view by using {ProjectWebUI} + +[role="_abstract"] +Use this procedure to create a content view by using the {ProjectWebUI}. + +While you can stipulate whether you want to resolve any package dependencies on a content view by content view basis, you might want to change the default {Project} settings to enable or disable package resolution for all content views. +For more information, see xref:Resolving_Package_Dependencies_{context}[]. + +.Procedure +. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. +. Click *Create content view*. +. In the *Name* field, enter a name for the view. +{Project} automatically completes the *Label* field from the name you enter. +. In the *Description* field, enter a description of the view. +. In the *Type* field, select a *Content view* or a *Composite content view*. +. Optional: If you want to solve dependencies automatically every time you publish this content view, select the *Solve dependencies* checkbox. +Dependency solving slows the publishing time and might ignore any content view filters you use. +This can also cause errors when resolving dependencies for errata. +. Click *Create content view*. +. On the *Repositories* tab, select the repository from the *Type* list that you want to add to your content view, select the checkbox next to the available repositories you want to add, then click *Add repositories*. +. Click *Publish new version* and in the *Description* field, enter information about the version to log changes. +. Optional: Enable a promotion path by clicking *Promote* and select one or more lifecycle environments to promote the new version to. +. Click *Next*. +. On the *Review details* page, review the environments you are trying to publish. +. Click *Finish*. + +.Next steps +* To register a host to your content view, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. diff --git a/guides/common/modules/proc_creating-a-content-view-filter-by-using-cli.adoc b/guides/common/modules/proc_creating-a-content-view-filter-by-using-cli.adoc index 5e09cf68fd9..91e9373c300 100644 --- a/guides/common/modules/proc_creating-a-content-view-filter-by-using-cli.adoc +++ b/guides/common/modules/proc_creating-a-content-view-filter-by-using-cli.adoc @@ -3,6 +3,7 @@ [id="creating-a-content-view-filter-by-using-cli"] = Creating a content view filter by using CLI +[role="_abstract"] You can use Hammer CLI to create content view filters to include or exclude specific content units like packages, errata, or container image tags. .Procedure diff --git a/guides/common/modules/proc_creating-a-content-view-filter-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-content-view-filter-by-using-web-ui.adoc index dbb29efef3e..d632c058f1b 100644 --- a/guides/common/modules/proc_creating-a-content-view-filter-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-a-content-view-filter-by-using-web-ui.adoc @@ -3,6 +3,7 @@ [id="creating-a-content-view-filter-by-using-web-ui"] = Creating a content view filter by using {ProjectWebUI} +[role="_abstract"] You can filter content views containing {client-content-type} content to include or exclude specific packages or errata. Package filters are based on a combination of the _name_, _version_, and _architecture_. For examples of how to build a filter, see xref:Content_Filter_Examples_{context}[]. diff --git a/guides/common/modules/proc_creating-a-content-view-filter-for-errata-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-content-view-filter-for-errata-by-using-web-ui.adoc index 66ba124866b..48f9d6ffb98 100644 --- a/guides/common/modules/proc_creating-a-content-view-filter-for-errata-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-a-content-view-filter-for-errata-by-using-web-ui.adoc @@ -16,7 +16,7 @@ Then you can modify the filter's start date to introduce new errata into your te .Prerequisites * A content view with the repositories that contain required errata is created. -For more information, see xref:Creating_a_Content_View_{context}[]. +For more information, see xref:creating-a-content-view-by-using-web-ui[]. .Procedure . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. diff --git a/guides/common/modules/proc_creating-a-content-view.adoc b/guides/common/modules/proc_creating-a-content-view.adoc deleted file mode 100644 index 5fc6f61371f..00000000000 --- a/guides/common/modules/proc_creating-a-content-view.adoc +++ /dev/null @@ -1,78 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="Creating_a_Content_View_{context}"] -= Creating a content view - -Use this procedure to create a simple content view. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-content-view_{context}[]. - -.Prerequisites - -While you can stipulate whether you want to resolve any package dependencies on a content view by content view basis, you might want to change the default {Project} settings to enable or disable package resolution for all content views. -For more information, see xref:Resolving_Package_Dependencies_{context}[]. - -.Procedure -. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. -. Click *Create content view*. -. In the *Name* field, enter a name for the view. -{Project} automatically completes the *Label* field from the name you enter. -. In the *Description* field, enter a description of the view. -. In the *Type* field, select a *Content view* or a *Composite content view*. -. Optional: If you want to solve dependencies automatically every time you publish this content view, select the *Solve dependencies* checkbox. -Dependency solving slows the publishing time and might ignore any content view filters you use. -This can also cause errors when resolving dependencies for errata. -. Click *Create content view*. - -.Content view steps -. Click *Create content view* to create the content view. -. In the *Repositories* tab, select the repository from the *Type* list that you want to add to your content view, select the checkbox next to the available repositories you want to add, then click *Add repositories*. -. Click *Publish new version* and in the *Description* field, enter information about the version to log changes. -. Optional: You can enable a promotion path by clicking *Promote* to *Select a lifecycle environment from the available promotion paths to promote new version*. -. Click *Next*. -. On the *Review* page, you can review the environments you are trying to publish. -. Click *Finish*. - -You can view the content view on the *Content Views* page. -To view more information about the content view, click the content view name. -To register a host to your content view, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. - -[id="cli-creating-a-content-view_{context}"] -.CLI procedure -. Obtain a list of repository IDs: -+ -[options="nowrap", subs="+quotes,verbatim,attributes"] ----- -$ hammer repository list --organization "_My_Organization_" ----- -. Create the content view and add repositories: -+ -[options="nowrap", subs="+quotes,verbatim,attributes"] ----- -$ hammer content-view create \ ---description "_My_Content_View_" \ ---name "_My_Content_View_" \ ---organization "_My_Organization_" \ ---repository-ids 1,2 ----- -+ -For the `--repository-ids` option, you can find the IDs in the output of the `hammer repository list` command. -. Publish the view: -+ -[options="nowrap", subs="+quotes,verbatim,attributes"] ----- -$ hammer content-view publish \ ---description "_My_Content_View_" \ ---name "_My_Content_View_" \ ---organization "_My_Organization_" ----- -. Optional: To add a repository to an existing content view, enter the following command: -+ -[options="nowrap", subs="+quotes,verbatim,attributes"] ----- -$ hammer content-view add-repository \ ---name "_My_Content_View_" \ ---organization "_My_Organization_" \ ---repository-id _repository_ID_ ----- - -{ProjectServer} creates the new version of the view and publishes it to the Library environment. diff --git a/guides/common/modules/proc_creating-a-rolling-content-view-by-using-cli.adoc b/guides/common/modules/proc_creating-a-rolling-content-view-by-using-cli.adoc new file mode 100644 index 00000000000..e54e3c93873 --- /dev/null +++ b/guides/common/modules/proc_creating-a-rolling-content-view-by-using-cli.adoc @@ -0,0 +1,42 @@ +:_mod-docs-content-type: PROCEDURE + +[id="creating-a-rolling-content-view-by-using-cli"] += Creating a rolling content view by using Hammer CLI + +[role="_abstract"] +You can create a rolling content view by using Hammer CLI. + +.Procedure +. List all available lifecycle environments: ++ +[options="nowrap" subs="+quotes"] +---- +$ hammer lifecycle-environment list \ +--fields id,name \ +--organization "_My_Organization_" +---- +. List all available repositories to identify IDs of repositories to add to your rolling content view: ++ +[options="nowrap" subs="+quotes"] +---- +$ hammer repository list \ +--fields id,name,product \ +--organization "_My_Organization_" +---- +. Create your rolling content view: ++ +[options="nowrap" subs="+quotes"] +---- +$ hammer content-view create \ +--lifecycle-environment-ids _My_List_Of_Lifecycle_Environment_IDs_ \ +--name "_My_Rolling_Content_View_" \ +--organization "_My_Organization_" \ +--repository-ids _My_List_Of_Repository_IDs_ \ +--rolling +---- + +.Next steps +* You cannot publish or promote your rolling content view. +Instead, continue by adding it to your activation key. +For more information, see xref:Creating_an_Activation_Key_{context}[]. +* To register a host to your rolling content view, see {ManagingHostsDocURL}registering-hosts-and-setting-up-host-integration_managing-hosts[Registering hosts and setting up host integration] in _{ManagingHostsDocTitle}_. diff --git a/guides/common/modules/proc_creating-a-rolling-content-view.adoc b/guides/common/modules/proc_creating-a-rolling-content-view-by-using-web-ui.adoc similarity index 54% rename from guides/common/modules/proc_creating-a-rolling-content-view.adoc rename to guides/common/modules/proc_creating-a-rolling-content-view-by-using-web-ui.adoc index 9dd619764a2..f28027a24ab 100644 --- a/guides/common/modules/proc_creating-a-rolling-content-view.adoc +++ b/guides/common/modules/proc_creating-a-rolling-content-view-by-using-web-ui.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: PROCEDURE -[id="creating-a-rolling-content-view"] -= Creating a rolling content view +[id="creating-a-rolling-content-view-by-using-web-ui"] += Creating a rolling content view by using {ProjectWebUI} -You can create a rolling content view in the {ProjectWebUI}. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-rolling-content-view[]. +[role="_abstract"] +You can create a rolling content view by using {ProjectWebUI}. .Procedure . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. @@ -19,36 +19,6 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-rollin . Select the repositories that you want to add to your rolling content view. . Click *Add repositories* to add all selected repositories to your rolling content view. -[id="cli-creating-a-rolling-content-view"] -.CLI procedure -. List all available lifecycle environments: -+ -[options="nowrap" subs="+quotes"] ----- -$ hammer lifecycle-environment list \ ---fields id,name \ ---organization "_My_Organization_" ----- -. List all available repositories to identify IDs of repositories to add to your rolling content view: -+ -[options="nowrap" subs="+quotes"] ----- -$ hammer repository list \ ---fields id,name,product \ ---organization "_My_Organization_" ----- -. Create your rolling content view: -+ -[options="nowrap" subs="+quotes"] ----- -$ hammer content-view create \ ---lifecycle-environment-ids _My_List_Of_Lifecycle_Environment_IDs_ \ ---name "_My_Rolling_Content_View_" \ ---organization "_My_Organization_" \ ---repository-ids _My_List_Of_Repository_IDs_ \ ---rolling ----- - .Next steps * You cannot publish or promote your rolling content view. Instead, continue by adding it to your activation key. diff --git a/guides/common/modules/proc_creating-an-activation-key-to-consume-the-content-view.adoc b/guides/common/modules/proc_creating-an-activation-key-to-consume-the-content-view.adoc index 465738dc319..ba5bad3c8dd 100644 --- a/guides/common/modules/proc_creating-an-activation-key-to-consume-the-content-view.adoc +++ b/guides/common/modules/proc_creating-an-activation-key-to-consume-the-content-view.adoc @@ -3,7 +3,7 @@ [id="Creating_an_Activation_Key_to_Consume_the_Content_View_{context}"] = Creating an activation key to consume the content view -Create another activation key to assign hosts to the content view you created in xref:Creating_a_Content_View_{context}[]. +Create another activation key to assign hosts to the content view you created in xref:creating-a-content-view-by-using-web-ui[]. .Procedure . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Activation Keys*. diff --git a/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc b/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc index 2cc50921258..aea9edb5d8c 100644 --- a/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc +++ b/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc @@ -3,6 +3,7 @@ [id="Deleting_Multiple_Content_View_Versions_{context}"] = Deleting multiple content view versions +[role="_abstract"] You can delete multiple content view versions simultaneously. .Procedure diff --git a/guides/common/modules/proc_distributing-archived-content-view-versions.adoc b/guides/common/modules/proc_distributing-archived-content-view-versions.adoc index 5aa59ec787d..931cc4f687e 100644 --- a/guides/common/modules/proc_distributing-archived-content-view-versions.adoc +++ b/guides/common/modules/proc_distributing-archived-content-view-versions.adoc @@ -3,6 +3,7 @@ [id="Distributing_Archived_Content_View_Versions_{context}"] = Distributing archived content view versions +[role="_abstract"] The setting *Distribute archived content view versions* enables hosting of non-promoted content view version repositories in the {Project} content web application along with other repositories. This is useful while debugging to see what content is present in your content view versions. diff --git a/guides/common/modules/proc_enabling-dependency-solving-for-a-content-view.adoc b/guides/common/modules/proc_enabling-dependency-solving-for-a-content-view.adoc index 52bb551a42c..50e14260b82 100644 --- a/guides/common/modules/proc_enabling-dependency-solving-for-a-content-view.adoc +++ b/guides/common/modules/proc_enabling-dependency-solving-for-a-content-view.adoc @@ -3,6 +3,7 @@ [id="enabling-dependency-solving-for-a-content-view_{context}"] = Enabling dependency solving for a content view +[role="_abstract"] Use this procedure to enable dependency solving for a content view. .Prerequisites diff --git a/guides/common/modules/proc_promoting-a-content-view-by-using-cli.adoc b/guides/common/modules/proc_promoting-a-content-view-by-using-cli.adoc new file mode 100644 index 00000000000..953bb58f045 --- /dev/null +++ b/guides/common/modules/proc_promoting-a-content-view-by-using-cli.adoc @@ -0,0 +1,35 @@ +:_mod-docs-content-type: PROCEDURE + +[id="promoting-a-content-view-by-using-cli"] += Promoting a content view by using Hammer CLI + +[role="_abstract"] +Use this procedure to promote content views across different lifecycle environments by using Hammer CLI. + +.Prerequisites +* Your {Project} account has a role that grants the `promote_or_remove_content_views` and `promote_or_remove_content_views_to_environment` permissions. + +.Procedure +* Promote the content view to a lifecycle environment: ++ +[options="nowrap" subs="+quotes"] +---- +$ hammer content-view version promote \ +--content-view "_My_Content_View_Name_" \ +--version 1 \ +--to-lifecycle-environment "_My_Lifecycle_Environment_Name_" \ +--organization "_My_Organization_" +---- ++ +Repeat the command for each lifecycle environment to promote the content view to. + +.Verification +* Display information about your content view version to verify that it is promoted to the required lifecycle environment: ++ +[options="nowrap" subs="verbatim,quotes"] +---- +$ hammer content-view version info --id _My_Content_View_Version_ID_ +---- + +.Next steps +* To register a host to your content view, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. diff --git a/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc b/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc new file mode 100644 index 00000000000..2b3dc6fa241 --- /dev/null +++ b/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc @@ -0,0 +1,19 @@ +:_mod-docs-content-type: PROCEDURE + +[id="promoting-a-content-view-by-using-web-ui"] += Promoting a content view by using {ProjectWebUI} + +[role="_abstract"] +Use this procedure to promote content views across different lifecycle environments by using {ProjectWebUI}. + +.Prerequisites +* Your {Project} account has a role that grants the `promote_or_remove_content_views` and `promote_or_remove_content_views_to_environment` permissions. + +.Procedure +. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. +. Select the content view that you want to promote. +. Select the version that you want to promote, click the vertical ellipsis icon, and click *Promote*. +. Select the environment where you want to promote the content view and click *Promote*. + +.Next steps +* To register a host to your content view, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. diff --git a/guides/common/modules/proc_promoting-a-content-view-to-all-environments-in-an-organization.adoc b/guides/common/modules/proc_promoting-a-content-view-to-all-environments-in-an-organization.adoc new file mode 100644 index 00000000000..26939a68d9b --- /dev/null +++ b/guides/common/modules/proc_promoting-a-content-view-to-all-environments-in-an-organization.adoc @@ -0,0 +1,24 @@ +:_mod-docs-content-type: PROCEDURE + +[id="promoting-a-content-view-to-all-environments-in-an-organization"] += Promoting a content view to all environments in an organization + +[role="_abstract"] +You can promote content views across all lifecycle environments within an organization by using the following Bash script. + +.Prerequisites +* Your {Project} account has a role that grants the `promote_or_remove_content_views` and `promote_or_remove_content_views_to_environment` permissions. + +.Procedure +* Promote content views across all lifecycle environments within an organization: ++ +[source,terminal,options="nowrap" subs="verbatim,quotes"] +---- +ORG="_My_Organization_" +CVV_ID=_My_Content_View_Version_ID_ + +for i in $(hammer --no-headers --csv lifecycle-environment list --organization $ORG | awk -F, {'print $1'} | sort -n) +do + hammer content-view version promote --organization $ORG --to-lifecycle-environment-id $i --id $CVV_ID +done +---- diff --git a/guides/common/modules/proc_promoting-a-content-view.adoc b/guides/common/modules/proc_promoting-a-content-view.adoc deleted file mode 100644 index 225e681e681..00000000000 --- a/guides/common/modules/proc_promoting-a-content-view.adoc +++ /dev/null @@ -1,79 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="Promoting_a_Content_View_{context}"] -= Promoting a content view - -Use this procedure to promote content views across different lifecycle environments. -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-promoting-a-content-view_{context}[]. - -.Permission requirements for content view promotion - -Non-administrator users require two permissions to promote a content view to an environment: - -. `promote_or_remove_content_views` -. `promote_or_remove_content_views_to_environment`. - -The `promote_or_remove_content_views` permission restricts which content views a user can promote. - -The `promote_or_remove_content_views_to_environment` permission restricts the environments to which a user can promote content views. - -With these permissions you can assign users permissions to promote certain content views to certain environments, but not to other environments. -For example, you can limit a user so that they are permitted to promote to test environments, but not to production environments. - -You must assign both permissions to a user to allow them to promote content views. - -.Procedure -. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. -. Select the content view that you want to promote. -. Select the version that you want to promote, click the vertical ellipsis icon, and click *Promote*. -. Select the environment where you want to promote the content view and click *Promote*. - -Now the repository for the content view appears in all environments. - -[id="cli-promoting-a-content-view_{context}"] -.CLI procedure -* Promote the content view using Hammer for each lifecycle environment: -+ -[options="nowrap" subs="+quotes"] ----- -$ hammer content-view version promote \ ---content-view "Database" \ ---version 1 \ ---to-lifecycle-environment "Development" \ ---organization "_My_Organization_" -$ hammer content-view version promote \ ---content-view "Database" \ ---version 1 \ ---to-lifecycle-environment "Testing" \ ---organization "_My_Organization_" -$ hammer content-view version promote \ ---content-view "Database" \ ---version 1 \ ---to-lifecycle-environment "Production" \ ---organization "_My_Organization_" ----- -+ -Now the database content is available in all environments. -* Alternatively, you can promote content views across all lifecycle environments within an organization using the following Bash script: -+ -[source,terminal,options="nowrap" subs="verbatim,quotes"] ----- -ORG="_My_Organization_" -CVV_ID=_My_Content_View_Version_ID_ - -for i in $(hammer --no-headers --csv lifecycle-environment list --organization $ORG | awk -F, {'print $1'} | sort -n) -do - hammer content-view version promote --organization $ORG --to-lifecycle-environment-id $i --id $CVV_ID -done ----- - -.Verification -* Display information about your content view version to verify that it is promoted to the required lifecycle environments: -+ -[options="nowrap" subs="verbatim,quotes"] ----- -$ hammer content-view version info --id _My_Content_View_Version_ID_ ----- - -.Next steps -* To register a host to your content view, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. diff --git a/guides/common/modules/proc_providing-the-salt-client-to-salt-minions.adoc b/guides/common/modules/proc_providing-the-salt-client-to-salt-minions.adoc index 9ce962c7350..4be3bfefab0 100644 --- a/guides/common/modules/proc_providing-the-salt-client-to-salt-minions.adoc +++ b/guides/common/modules/proc_providing-the-salt-client-to-salt-minions.adoc @@ -29,12 +29,12 @@ endif::[] . Synchronize the previously created products. For more information, see {ContentManagementDocURL}repository-synchronization[Repository synchronization]. . Create a content view for each repository. -For more information, see {ContentManagementDocURL}Creating_a_Content_View_content-management[Creating a content view]. +For more information, see {ContentManagementDocURL}creating-a-content-view-by-using-web-ui[Creating a content view by using {ProjectWebUI}]. . Create a composite content view for each major version of each operating system to make the new content available. -For more information, see {ContentManagementDocURL}Creating_a_Composite_Content_View_content-management[Create a composite content view]. +For more information, see {ContentManagementDocURL}creating-a-composite-content-view-by-using-web-ui[Create a composite content view by using {ProjectWebUI}]. . Add each of your operating system specific Salt content views to your main composite content view for that operating system and version. . Publish a new version of the composite content view from the previous step. . Promote the content view from the previous step to your lifecycle environments as appropriate. -For more information, see {ContentManagementDocURL}Promoting_a_Content_View_content-management[Promoting a content view]. +For more information, see {ContentManagementDocURL}promoting-a-content-view-by-using-web-ui[Promoting a content view by using {ProjectWebUI}]. . Optional: Create activation keys for your composite content view and lifecycle environment combinations. endif::[] diff --git a/guides/common/modules/proc_synchronizing-a-content-view-to-a-smart-proxy-server.adoc b/guides/common/modules/proc_synchronizing-a-content-view-to-a-smart-proxy-server.adoc index 8ef2ae087cc..93556a05339 100644 --- a/guides/common/modules/proc_synchronizing-a-content-view-to-a-smart-proxy-server.adoc +++ b/guides/common/modules/proc_synchronizing-a-content-view-to-a-smart-proxy-server.adoc @@ -3,10 +3,11 @@ [id="synchronizing-a-content-view-to-a-{smart-proxy-context}-server"] = Synchronizing a content view to a {SmartProxyServer} +[role="_abstract"] In the {ProjectWebUI}, you can only synchronize all selected lifecycle environments simultaneously. If you need to synchronize smaller items, such as individual lifecycle environments, single content views, and single repositories, use the Hammer CLI. -.CLI procedure +.Procedure * Synchronize a content view to your {SmartProxyServer}: + [options="nowrap", subs="+quotes,attributes"] @@ -15,6 +16,3 @@ $ {hammer-smart-proxy} content synchronize \ --content-view "_My_Content_View_Name_" \ --id __My_{smart-proxy-context-titlecase}_Server_ID__ ---- - -.Additional resources -* For more information about the command, run `{hammer-smart-proxy} content synchronize --help`. diff --git a/guides/common/modules/proc_synchronizing-suse-content.adoc b/guides/common/modules/proc_synchronizing-suse-content.adoc index b0d88b24487..a96a478c95d 100644 --- a/guides/common/modules/proc_synchronizing-suse-content.adoc +++ b/guides/common/modules/proc_synchronizing-suse-content.adoc @@ -15,16 +15,16 @@ For more information, see xref:Importing_SUSE_Products_{context}[]. . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. . Create a content view called `SLES {client-os-major}.{client-os-minor}` comprising the SLES repositories created in the `SLES {client-os-major}.{client-os-minor}` product and a content view called `SLES {client-os-major}.{client-os-minor} {Project} client` comprising the {project-client-name} repository created in the `SLES {client-os-major}.{client-os-minor} {Project} client` product. + -For more information, see xref:Creating_a_Content_View_{context}[]. +For more information, see xref:creating-a-content-view-by-using-web-ui[]. . Publish a new version of both content views. + -For more information, see xref:Promoting_a_Content_View_{context}[]. +For more information, see xref:promoting-a-content-view-by-using-web-ui[]. . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. . Click *Create Content View* to create a composite content view called `Composite SLES {client-os-major}.{client-os-minor}` comprising the previously published `SLES {client-os-major}.{client-os-minor}` content view, the `SLES {client-os-major}.{client-os-minor} {Project} client` content view, and optionally further content views of your choice, for example a content view containing Puppet. ifdef::orcharhino[] For more information, see {atix-kb-clients} in the _ATIX Service Portal_. endif::[] -For more information, see xref:Creating_a_Composite_Content_View_{context}[]. +For more information, see xref:creating-a-composite-content-view-by-using-web-ui[]. . Publish a new version and promote this version to the lifecycle environment of your choice. . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Activation Keys*. . Click *Create Activation Key* to create an activation key called `sles-{client-os-major}-{client-os-minor}`. diff --git a/guides/common/modules/proc_viewing-module-streams-by-using-cli.adoc b/guides/common/modules/proc_viewing-module-streams-by-using-cli.adoc new file mode 100644 index 00000000000..7243c12af73 --- /dev/null +++ b/guides/common/modules/proc_viewing-module-streams-by-using-cli.adoc @@ -0,0 +1,22 @@ +:_mod-docs-content-type: PROCEDURE + +[id="viewing-module-streams-by-using-cli"] += Viewing module streams by using Hammer CLI + +[role="_abstract"] +In {Project}, you can view the module streams of the repositories in your content views by using Hammer CLI. + +.Procedure +. List all organizations: ++ +[options="nowrap", subs="+quotes,verbatim,attributes"] +---- +$ hammer organization list +---- +. View all module streams for your organization: ++ +[options="nowrap", subs="+quotes,verbatim,attributes"] +---- +$ hammer module-stream list \ +--organization-id _My_Organization_ID_ +---- diff --git a/guides/common/modules/proc_viewing-module-streams-by-using-web-ui.adoc b/guides/common/modules/proc_viewing-module-streams-by-using-web-ui.adoc new file mode 100644 index 00000000000..ce0c4283fe2 --- /dev/null +++ b/guides/common/modules/proc_viewing-module-streams-by-using-web-ui.adoc @@ -0,0 +1,15 @@ +:_mod-docs-content-type: PROCEDURE + +[id="viewing-module-streams-by-using-web-ui"] += Viewing module streams by using {ProjectWebUI} + +[role="_abstract"] +You can view the module streams of the repositories in your content views by using {ProjectWebUI}. + +.Procedure +. In the {ProjectWebUI}, *Content* > *Lifecycle* > *Content Views*. +. Select your content view. +. Click on a published version. +. Click *Module Streams* to view the module streams that are available for the Content Types. +. Use the *Search* field to search for specific modules. +. To view the information about the module, click the module and its corresponding tabs to include *Details*, *Repositories*, *Profiles*, and *Artifacts*. diff --git a/guides/common/modules/proc_viewing-module-streams.adoc b/guides/common/modules/proc_viewing-module-streams.adoc deleted file mode 100644 index 6db1278af54..00000000000 --- a/guides/common/modules/proc_viewing-module-streams.adoc +++ /dev/null @@ -1,29 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="Viewing_Module_Streams_{context}"] -= Viewing module streams - -In {Project}, you can view the module streams of the repositories in your content views. - -To use the CLI instead of the {ProjectWebUI}, see the xref:cli-Viewing_Module_Streams_{context}[]. - -.Procedure -. In the {ProjectWebUI}, navigate to a published version of a *Content View* > *Module Streams* to view the module streams that are available for the Content Types. -. Use the *Search* field to search for specific modules. -. To view the information about the module, click the module and its corresponding tabs to include *Details*, *Repositories*, *Profiles*, and *Artifacts*. - -[id="cli-Viewing_Module_Streams_{context}"] -.CLI procedure -. List all organizations: -+ -[options="nowrap", subs="+quotes,verbatim,attributes"] ----- -$ hammer organization list ----- -. View all module streams for your organization: -+ -[options="nowrap", subs="+quotes,verbatim,attributes"] ----- -$ hammer module-stream list \ ---organization-id _My_Organization_ID_ ----- diff --git a/guides/common/modules/ref_best-practices-for-content-views.adoc b/guides/common/modules/ref_best-practices-for-content-views.adoc index 3bbd2fcc677..15ee90b6c0a 100644 --- a/guides/common/modules/ref_best-practices-for-content-views.adoc +++ b/guides/common/modules/ref_best-practices-for-content-views.adoc @@ -3,6 +3,9 @@ [id="best-practices-for-content-views_{context}"] = Best practices for content views +[role="_abstract"] +{Team} recommends you follow these practices for content views. + * Content views that bundle content, such as {client-os} and additional software like `Apache-2.4` or `PostgreSQL-16.2`, are easier to maintain. Content views that are too small require more maintenance. * If you require daily updated content, use the content view `Default Organization View`, which contains the latest synchronized content from all repositories and is available in the Library lifecycle environment. diff --git a/guides/common/modules/ref_best-practices-for-patching-content-hosts.adoc b/guides/common/modules/ref_best-practices-for-patching-content-hosts.adoc index a1dae0c9746..ca520c97a6f 100644 --- a/guides/common/modules/ref_best-practices-for-patching-content-hosts.adoc +++ b/guides/common/modules/ref_best-practices-for-patching-content-hosts.adoc @@ -3,6 +3,9 @@ [id="best-practices-for-patching-content-hosts_{context}"] = Best practices for patching content hosts +[role="_abstract"] +{Team} recommends you follow these practices for patching content hosts. + * Registering hosts to {Project} requires {project-client-name}, which contains the `katello-host-tools` package and its dependencies. For more information, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. * Use the {ProjectWebUI} to install, upgrade, and remove packages from hosts. diff --git a/guides/common/modules/ref_glossary-of-terms-used-in-project.adoc b/guides/common/modules/ref_glossary-of-terms-used-in-project.adoc index 3d5ce335644..990ee0fb5e0 100644 --- a/guides/common/modules/ref_glossary-of-terms-used-in-project.adoc +++ b/guides/common/modules/ref_glossary-of-terms-used-in-project.adoc @@ -374,7 +374,7 @@ endif::[] [[Promote]] Promote (a content view):: The act of moving a content view from one lifecycle environment to another. -For more information, see {ContentManagementDocURL}Promoting_a_Content_View_content-management[Promoting a content view] in _{ContentManagementDocTitle}_. +For more information, see {ContentManagementDocURL}promoting-a-content-view-by-using-web-ui[Promoting a content view] in _{ContentManagementDocTitle}_. endif::[] [[Provisioning]]