TELCODOCS-1476 hub-side templating #68139

slovern · 2023-11-17T15:42:44Z

[WIP] [TELCODOCS-1478](https://issues.redhat.com//browse/TELCODOCS-1478) hub-side templating

ON HOLD subject to updates to TALM (https://issues.redhat.com/browse/CNF-9102)

Version(s): TBD

Issue: https://issues.redhat.com/browse/TELCODOCS-1476

Link to docs preview:

About the PolicyGenTemplate CRD (new example PGT added)

Deploying a managed cluster with SiteConfig and GitOps ZTP
(added new optional procedure step 3.e)

QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2023-11-17T15:50:23Z

🤖 Updated build preview is available at:
https://68139--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/35226

modules/ztp-deploying-siteconfig-hub-side-template.adoc

irinamihai · 2023-11-17T21:31:56Z

modules/ztp-deploying-siteconfig-hub-side-template.adoc

+[id="ztp-deploying-siteconfig-hub-side-template_{context}"]
+= Deploying a SiteConfig with hub-side templating
+
+The following is an example `SiteConfig` custom resource (CR) that uses the `spec.clusters.siteConfigMap.data` field to specify per-site data to be used in hub side templating.


Suggested change

The following is an example `SiteConfig` custom resource (CR) that uses the `spec.clusters.siteConfigMap.data` field to specify per-site data to be used in hub side templating.

The following is a `SiteConfig` custom resource (CR) example that includes the new optional `spec.clusters.siteConfigMap` where the `data` field contains per-site data to be used in hub side templating.

There can be an issue with referring to a feature as "new" or "optional" in product documentation because, as time passes, the feature ceases to be new but the documentation won't be updated to reflect that. Release Notes are the best place to point out the newness of a feature.
I've rephrased though, in order to draw attention to the spec.clusters.siteConfigMap section and mention the data field separately

Ok, but I think we should still say that it's an optional section, it's not mandatory. 🤔

irinamihai · 2023-11-17T21:34:50Z

modules/ztp-deploying-siteconfig-hub-side-template.adoc

+----
+[NOTE]
+====
+The generated `ConfigMap` CRs follow the naming convention `ztp-site-<cluster_name>-configMap` and are created under the same namespace as the policy resource.


Maybe just leave

The generated ConfigMap CRs follow the naming convention ztp-site-<cluster_name>.

since you're explaining the namespace aspect below?

ok. I removed reference to the namespace and left it at ztp-site-<cluster_name>-configMap.

It should be ztp-site-<cluster-name> though.

irinamihai · 2023-11-17T21:36:40Z

modules/ztp-deploying-siteconfig-hub-side-template.adoc

+====
+The generated `ConfigMap` CRs follow the naming convention `ztp-site-<cluster_name>-configMap` and are created under the same namespace as the policy resource.
+
+The `siteConfigMap` section includes the namespace where the `ConfigMap` is to be created.


Suggested change

The `siteConfigMap` section includes the namespace where the `ConfigMap` is to be created.

The `siteConfigMap` section includes the namespace where the `ConfigMap` is to be created and its name.

sorry @irinamihai I'm not clear on what the "its" refers to here.
Is "its name" the name of the namespace or the name of the ConfigMap?
The "name of the ConfigMap" doesn't seem right but the "name of the namespace" sounds kinda off too.

name refers to ConfigMap - add this to the example yaml
Something like
SiteConfigMap
name: site-example-sno

irinamihai · 2023-11-17T21:37:13Z

modules/ztp-deploying-siteconfig-hub-side-template.adoc

+The generated `ConfigMap` CRs follow the naming convention `ztp-site-<cluster_name>-configMap` and are created under the same namespace as the policy resource.
+
+The `siteConfigMap` section includes the namespace where the `ConfigMap` is to be created.
+The `siteConfigMap.namespace` you specify must be the same as the namespace used by the `PolicyGenTemplate` resources.


Suggested change

The `siteConfigMap.namespace` you specify must be the same as the namespace used by the `PolicyGenTemplate` resources.

For a successful integration with the PolicyGenTemplate, the `siteConfigMap.namespace` you specify must be the same as the namespace used by the `PolicyGenTemplate` resources.

irinamihai · 2023-11-17T21:42:16Z

modules/ztp-deploying-siteconfig-hub-side-template.adoc

+----
+include::snippets/ztp_example-siteconfig-hub-side-templating.yaml[]
+----
+[NOTE]


Maybe the section below can be a bit restructured to something like:

Besides the data field, the siteConfigMap section also includes the namespace where the ConfigMap is to be created and its name.

For a successful integration with the PolicyGenTemplate, the siteConfigMap.namespace you specify must be the same as the namespace used by the PolicyGenTemplate resources.

If not specified, siteConfigMap.namespace will default to , and siteConfigMap.namespace to ztp-site-<cluster_name>.

Maybe we could have another look at this together?

irinamihai · 2023-11-20T15:27:32Z

modules/ztp-the-policygentemplate.adoc

                                    .....
 ----
+
+The following example uses hub-side templating to generate multiple `machineConfigs` from a single {rh-rhacm} policy:


The following example uses hub side templating to generate PerformanceProfile {rh-rhacm} policies for the cluster that have the following labels: group-du-sno-zone: "zone-1", hardware-type: "dell-poweredge-xr12".

Thanks. I've proposed a change along these lines.

irinamihai · 2023-11-22T16:18:45Z

modules/ztp-deploying-a-site.adoc

+      dell-poweredge-xr12-ptpcfgslave-profile-interface: "ens5f0"
+      dell-poweredge-xr12-cpu-isolated: "2-19,22-39"
+      dell-poweredge-xr12-cpu-reserved: "0-1,20-21"
+      dell-poweredge-xr12-hugepages-default: "1G"
+      dell-poweredge-xr12-hugepages-size: "1G"
+      dell-poweredge-xr12-hugepages-count: "32"


Maybe we can remove this and instead include:

sno-1-sriov-network-vlan-1: "140" sno-1-sriov-network-vlan-2: "150"

irinamihai · 2023-11-22T16:23:55Z

modules/ztp-deploying-a-site.adoc

+
+[NOTE]
+====
+As an alternative to populating the siteConfigMap section in the `SiteConfig` CR you can store site-specific template data in the ZTP GitOps repo, as `ConfigMap` CRs, then push this template data to the hub cluster.


Suggested change

As an alternative to populating the siteConfigMap section in the `SiteConfig` CR you can store site-specific template data in the ZTP GitOps repo, as `ConfigMap` CRs, then push this template data to the hub cluster.

As an alternative to populating the siteConfigMap section in the `SiteConfig` CR you can store site-specific template data in the ZTP GitOps repo, as `ConfigMap` CRs, and have them synced to the hub cluster.

irinamihai · 2023-11-22T16:32:45Z

modules/ztp-the-policygentemplate.adoc

+include::snippets/ztp_example-pgt-hub-side-templating.yaml[]
+----
+
+Using the `fromConfigMap` function, the file defines site-specific configurations for each cluster defined in the `PolicyGenTemplate`. 


Suggested change

Using the `fromConfigMap` function, the file defines site-specific configurations for each cluster defined in the `PolicyGenTemplate`.

Using the `fromConfigMap` function, site-specific configuration is selected for each cluster defined in the `PolicyGenTemplate`.

irinamihai · 2023-11-22T16:32:55Z

modules/ztp-the-policygentemplate.adoc

+----
+
+Using the `fromConfigMap` function, the file defines site-specific configurations for each cluster defined in the `PolicyGenTemplate`. 
+This example generates policies for clsuters that have the labels: 


Suggested change

This example generates policies for clsuters that have the labels:

This example generates policies for clusters that have the labels:

openshift-bot · 2024-04-09T09:01:08Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-merge-robot · 2024-04-12T15:09:58Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci · 2024-04-12T15:09:59Z

@slovern: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/validate-portal	`78ef28a`	link	true	`/test validate-portal`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

openshift-bot · 2024-05-13T08:30:23Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

openshift-bot · 2024-06-13T00:01:20Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2024-06-13T00:02:17Z

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 17, 2023

slovern force-pushed the TELCODOCS-1476 branch from 5aaaecd to b1216dc Compare November 17, 2023 16:47

irinamihai reviewed Nov 17, 2023

View reviewed changes

modules/ztp-deploying-siteconfig-hub-side-template.adoc Outdated Show resolved Hide resolved

irinamihai reviewed Nov 17, 2023

View reviewed changes

irinamihai reviewed Nov 20, 2023

View reviewed changes

slovern force-pushed the TELCODOCS-1476 branch from b1216dc to 956b437 Compare November 21, 2023 16:26

openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 21, 2023

slovern force-pushed the TELCODOCS-1476 branch from 956b437 to 63a28e4 Compare November 21, 2023 17:04

irinamihai reviewed Nov 22, 2023

View reviewed changes

slovern force-pushed the TELCODOCS-1476 branch 4 times, most recently from 21d709c to 81a7e64 Compare November 24, 2023 14:56

TELCODOCS-1476 hub-side templating

78ef28a

slovern force-pushed the TELCODOCS-1476 branch from 81a7e64 to 78ef28a Compare November 30, 2023 12:39

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 9, 2024

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 12, 2024

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 13, 2024

openshift-ci bot closed this Jun 13, 2024

	The following is an example `SiteConfig` custom resource (CR) that uses the `spec.clusters.siteConfigMap.data` field to specify per-site data to be used in hub side templating.
	The following is a `SiteConfig` custom resource (CR) example that includes the new optional `spec.clusters.siteConfigMap` where the `data` field contains per-site data to be used in hub side templating.

	The `siteConfigMap` section includes the namespace where the `ConfigMap` is to be created.
	The `siteConfigMap` section includes the namespace where the `ConfigMap` is to be created and its name.

	The `siteConfigMap.namespace` you specify must be the same as the namespace used by the `PolicyGenTemplate` resources.
	For a successful integration with the PolicyGenTemplate, the `siteConfigMap.namespace` you specify must be the same as the namespace used by the `PolicyGenTemplate` resources.

	As an alternative to populating the siteConfigMap section in the `SiteConfig` CR you can store site-specific template data in the ZTP GitOps repo, as `ConfigMap` CRs, then push this template data to the hub cluster.
	As an alternative to populating the siteConfigMap section in the `SiteConfig` CR you can store site-specific template data in the ZTP GitOps repo, as `ConfigMap` CRs, and have them synced to the hub cluster.

	Using the `fromConfigMap` function, the file defines site-specific configurations for each cluster defined in the `PolicyGenTemplate`.
	Using the `fromConfigMap` function, site-specific configuration is selected for each cluster defined in the `PolicyGenTemplate`.

	This example generates policies for clsuters that have the labels:
	This example generates policies for clusters that have the labels:

TELCODOCS-1476 hub-side templating #68139

TELCODOCS-1476 hub-side templating #68139

Uh oh!

Conversation

slovern commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

irinamihai Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

irinamihai Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-bot commented Apr 9, 2024

Uh oh!

openshift-merge-robot commented Apr 12, 2024

Uh oh!

openshift-ci bot commented Apr 12, 2024

Uh oh!

openshift-bot commented May 13, 2024

Uh oh!

openshift-bot commented Jun 13, 2024

Uh oh!

openshift-ci bot commented Jun 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

slovern commented Nov 17, 2023 •

edited

Loading

ocpdocs-previewbot commented Nov 17, 2023 •

edited

Loading

irinamihai Nov 17, 2023 •

edited

Loading

irinamihai Nov 17, 2023 •

edited

Loading