Skip to content

[release-4.18] add systemd services for configuration after start #1063

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.

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

Conversation

openshift-cherrypick-robot
Copy link

@openshift-cherrypick-robot openshift-cherrypick-robot commented May 16, 2025

This is an automated cherry-pick of #980

/assign praveenkumar

Summary by Sourcery

Add a suite of systemd services and deployment logic to perform essential OpenShift/MicroShift provisioning steps inside the VM after startup, and document the new self-sufficient bundle capabilities.

New Features:

  • Introduce systemd units and scripts to perform cluster provisioning tasks post-start (e.g. pull-secret, DNSMasq, cluster CA, custom domain, routes controller, SSH key injection, cluster ID, GrowFS, cluster status, user passwords).
  • Add a copy_systemd_units step in the disk creation flow to deploy and enable these systemd services on the VM.

Enhancements:

  • Disable cloud-init network configuration and preserve the hostname in the guest VM.

Documentation:

  • Add documentation for self-sufficient OpenShift Local bundles and the systemd services they require.

the services does the various needed tasks to setup
the ocp or microshift cluster, these systemd  units
runs small shell scripts which are based on:
https://github.com/crc-org/crc-cloud/blob/main/pkg/bundle/setup/clustersetup.sh

and does the following tasks:
- creates crc specific configurations for dnsmasq
- sets a new uuid as cluster id
- creates the pod for routes-controller
- tries to grow the disk and filesystem
- checks if the cluster operators are ready
- adds the pull secret to the cluster
- sets kubeadmin and developer user passwords
- sets a custom ca for authentication
- sets custom nip.io cluster domain
Copy link

sourcery-ai bot commented May 16, 2025

Reviewer's Guide

This PR backports the systemd-based post-start configuration flow to release-4.18 by defining a new helper to deploy, enable, and clean up systemd units on the VM, disabling conflicting cloud-init behaviors, and adding all related unit scripts and documentation.

File-Level Changes

Change Details Files
Add copy_systemd_units helper and hook into VM provisioning
  • Define copy_systemd_units in createdisk-library.sh to template, transfer, enable, and clean up systemd units
  • Invoke copy_systemd_units after package installation in createdisk.sh
createdisk-library.sh
createdisk.sh
Disable cloud-init network and hostname updates
  • Generate /etc/cloud/cloud.cfg.d/05_disable-network.cfg via SSH to disable network config
  • Patch cloud.cfg to preserve the hostname
createdisk.sh
Introduce systemd unit scripts, service definitions, templates, and documentation
  • Add common helper and per-feature scripts for pull-secret, DNSMasq, routes controller, cluster CA, custom domain, cluster ID, growfs, SSH key injection, user passwords, and cluster status
  • Add corresponding .service and .path unit files plus dnsmasq template
  • Update .gitignore to include new systemd directory
  • Add docs/self-sufficient-bundle.md explaining service responsibilities and conventions
.gitignore
docs/self-sufficient-bundle.md
systemd/crc-systemd-common.sh
systemd/dnsmasq.sh.template
systemd/crc-pullsecret.sh
systemd/crc-routes-controller.sh
systemd/crc-cluster-status.sh
systemd/ocp-cluster-ca.sh
systemd/ocp-custom-domain.sh
systemd/ocp-userpasswords.sh
systemd/ocp-mco-sshkey.sh
systemd/ocp-clusterid.sh
systemd/ocp-growfs.sh
systemd/*.service
systemd/*.path

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@openshift-ci openshift-ci bot requested review from anjannath and cfergeau May 16, 2025 05:59
Copy link

openshift-ci bot commented May 16, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign gbraad for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

openshift-ci bot commented May 16, 2025

Hi @openshift-cherrypick-robot. Thanks for your PR.

I'm waiting for a crc-org member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@praveenkumar
Copy link
Member

/ok-to-test

@anjannath
Copy link
Member

/test e2e-snc

Copy link

openshift-ci bot commented May 16, 2025

@openshift-cherrypick-robot: 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/e2e-snc 5d2c6fb link true /test e2e-snc

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.

@praveenkumar praveenkumar merged commit abe8a14 into crc-org:release-4.18 May 19, 2025
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants