Skip to content

[WIP] TELCODOCS-1540: Installing SNO clusters with the SiteConfig Operator #78153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

[WIP] TELCODOCS-1540: Installing SNO clusters with the SiteConfig Operator #78153

wants to merge 2 commits into from

Conversation

@amolnar-gh
Copy link
Contributor

@amolnar-gh amolnar-gh commented Jun 27, 2024 •
edited
Loading

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 27, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 27, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TELCODOCS-1540 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.

In response to this:

Version(s): 4.17

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 27, 2024
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Jun 27, 2024
View reviewed changes
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Jun 27, 2024
View reviewed changes
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jun 27, 2024 •
edited
Loading

🤖 Fri Aug 02 12:47:57 - Prow CI generated the docs preview:
https://78153--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1540 branch 2 times, most recently from 9e429a4 to 2a22417 Compare June 27, 2024 11:04
@amolnar-gh amolnar-gh closed this Jun 27, 2024
@amolnar-gh amolnar-gh reopened this Jun 27, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 27, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TELCODOCS-1540 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.

In response to this:

Version(s): 4.17

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 27, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TELCODOCS-1540 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.

In response to this:

Version(s): 4.17

Issue:

Link to docs preview: https://78153--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/installing_with_siteconfig_operator/cnf-understanding-siteconfig-operator

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 28, 2024
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1540 branch 12 times, most recently from 29e457e to 1b849d2 Compare July 4, 2024 14:12
@openshift-ci openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 11, 2024
rohennes
rohennes reviewed Jul 11, 2024
View reviewed changes
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1540 branch 6 times, most recently from 687da35 to da99120 Compare July 15, 2024 10:48
sakhoury
sakhoury reviewed Jul 17, 2024
View reviewed changes
Copy link

@sakhoury sakhoury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work @amolnar-rh! Very well written 👍 I have added some minor comments.

modules/cnf-clusterinstance-cr-spec-config-parameters.adoc Outdated

|`holdInstallation`
|
a|Set to `true` to prevent installation.
Copy link

@sakhoury sakhoury Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missed review comment perhaps? ^^^

@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1540 branch 2 times, most recently from a2c56a3 to 972473f Compare July 17, 2024 10:04
carbonin
carbonin reviewed Jul 17, 2024
View reviewed changes
modules/cnf-deploying-siteconfig-operator.adoc
+
[source,terminal]
----
$ make install deploy CONTAINER_TOOL=podman IMG=quay.io/acm-d/siteconfig:latest
Copy link
Member

@carbonin carbonin Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this registry require authentication that a regular user wouldn't have?

Copy link

@sakhoury sakhoury Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to confirm this!

Copy link

@sakhoury sakhoury Jul 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gurnben is it possible to make this image public for general access? (cc @jnpacker)

carbonin
carbonin reviewed Jul 17, 2024
View reviewed changes
carbonin
carbonin reviewed Jul 17, 2024
View reviewed changes
modules/cnf-installing-clusters.adoc

.Procedure

. Create your cluster and node templates for the Image-based Install Operator by running the following commands:
Copy link
Member

@carbonin carbonin Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're using IBI as the templates here should we call out that there's a bunch of steps that you need to take before this to make IBI work properly?

I don't know if you want this to also be a full IBI doc, but maybe a link out to whatever we have for IBIO today?

Copy link

@sakhoury sakhoury Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor Author

@amolnar-gh amolnar-gh Jul 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a clarifying statement that the example procedure uses the IBI cluster templates, a requirement with links to AI and IBIO:

You have installed and configured the underlying Operator of your choice. For more information, see "Image-based installations for single-node OpenShift" or "Installing an on-premise cluster using the Assisted Installer" sections.

@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1540 branch 3 times, most recently from df70647 to bcb18ae Compare July 24, 2024 10:44
sakhoury
sakhoury reviewed Jul 30, 2024
View reviewed changes
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1540 branch 3 times, most recently from c53f1ac to 7220b29 Compare August 2, 2024 09:34
sakhoury
sakhoury reviewed Aug 2, 2024
View reviewed changes
@openshift-ci
Copy link

openshift-ci bot commented Aug 2, 2024

@amolnar-rh: all tests passed!

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-sigs/prow repository. I understand the commands that are listed here.

@amolnar-gh
Copy link
Contributor Author

amolnar-gh commented Aug 2, 2024

The work for the Dev Preview content is now complete and the KB article has been published. Any further comments will be implemented in the Tech Preview work. Please follow TELCODOCS-1875 for updates and links where feedback can be provided.

@amolnar-gh amolnar-gh closed this Aug 2, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 2, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TELCODOCS-1540 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.

In response to this:

Version(s): DP for 4.16

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

Link to docs preview: https://78153--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/installing_with_siteconfig_operator/cnf-understanding-siteconfig-operator

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

4 more reviewers

@sakhoury sakhoury sakhoury requested changes

@carbonin carbonin carbonin left review comments

@rohennes rohennes rohennes left review comments

@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@amolnar-gh @openshift-ci-robot @ocpdocs-previewbot @sakhoury @carbonin @rohennes @ocpdocs-vale-bot @openshift-merge-robot