✨ Add OCI source for provider ConfigMap preparation #683

Danil-Grigorev · 2025-01-13T16:59:56Z

What this PR does / why we need it:

Allow to specify OCI artifact source for pulling the provider manifests. Similar to URL, the content is stored in a ConfigMap, which is used as a source of truth for the provider state.

This functionality allows to pre-load provider manifests in airGapped environments.

A new operator plugin command is available:

kubectl operator preload -u ttl.sh/manifests:v0.0.1 --infrastructure docker

which fetches according manifests for the provider and outputs prepared ConfigMap resource.

To package and publish manifests, plugin publish subcommand can be used:

kubectl operator preload -d components_directory -u ttl.sh/manifests:v0.0.1

oras can be also used directly:

oras push ttl.sh/${IMAGE_NAME}:v1.9.3 metadata.yaml infrastructure-components.yaml

this image is later available as a source for the Provider resource:

apiVersion: operator.cluster.x-k8s.io/v1alpha2
kind: InfrastructureProvider
metadata:
  name: docker
spec:
  fetchConfig:
    oci: ttl.sh/${IMAGE_NAME}

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

netlify · 2025-01-13T17:00:13Z

✅ Deploy Preview for kubernetes-sigs-cluster-api-operator ready!

Name	Link
🔨 Latest commit	`2959930`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-cluster-api-operator/deploys/6797869814cc560008fd7eed
😎 Deploy Preview	https://deploy-preview-683--kubernetes-sigs-cluster-api-operator.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

alexander-demicev

thanks a lot! I added couple comments but none of them should block merging the PR

/approve

api/v1alpha2/provider_types.go

alexander-demicev · 2025-01-24T14:27:20Z

cmd/plugin/cmd/preload.go

+}
+
+// retryWithExponentialBackoff repeats an operation until it passes or the exponential backoff times out.
+func retryWithExponentialBackoff(ctx context.Context, opts wait.Backoff, operation func(ctx context.Context) error) error {


can this moved to util package or something similar?

alexander-demicev · 2025-01-24T14:30:40Z

cmd/plugin/cmd/preload.go

+
+// ociAuthentication returns user supplied credentials from provider variables.
+func ociAuthentication() *auth.Credential {
+	username := os.Getenv(providercontroller.OCIUsernameKey)


should authentication be documented?

Yes, I'll add documentation in the follow-up PR

alexander-demicev · 2025-01-24T14:32:01Z

cmd/plugin/cmd/publish.go

+		err = fs.Close()
+	}()
+
+	// 1. Add files to the file store


will it make sense to create some tmp directory as the file store?

Not in this case as this already reads a dir/file path provided by user. There is no need to do it, the dir as well may be a temporary already.

alexander-demicev · 2025-01-24T14:39:42Z

internal/controller/manifests_downloader.go

+	}
+
+	metadata, err := store.GetMetadata(provider)
+	if err != nil {


if metadata is empty should we return an error?

Yes, it is checked within the method. If the metadata is incorrect, it will also result in a phase error on the resource later on.

k8s-ci-robot · 2025-01-24T14:46:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alexander-demicev

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [alexander-demicev]

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

furkatgofurov7

Great work, thanks. Few non-blocking suggestions inline and below:

Can we have a guide/doc around how to use the new operator plugin as part of the book content as a follow-up?

cmd/plugin/cmd/init.go

internal/controller/preflight_checks.go

internal/controller/preflight_checks_test.go

test/e2e/resources/infrastructure-docker-v0.0.1-components.yaml

internal/controller/phases.go

internal/controller/manifests_downloader.go

furkatgofurov7 · 2025-01-27T11:43:15Z

@Danil-Grigorev can you please re-run make generate and push the changes?

Signed-off-by: Danil-Grigorev <[email protected]>

furkatgofurov7 · 2025-01-27T14:06:33Z

/lgtm

k8s-ci-robot · 2025-01-27T14:06:42Z

LGTM label has been added.

Git tree hash: b0ae962c2d7320158ae59c8975b5da530b872569

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 13, 2025

k8s-ci-robot requested review from alexander-demicev and Fedosin January 13, 2025 17:00

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 13, 2025

Danil-Grigorev force-pushed the oci-provider-source branch from 17be047 to db4106b Compare January 14, 2025 07:44

Danil-Grigorev mentioned this pull request Jan 14, 2025

Package provider manifests as OCI artifacts rancher/turtles#968

Open

Danil-Grigorev force-pushed the oci-provider-source branch 3 times, most recently from e202fd3 to ee6fbae Compare January 14, 2025 14:22

k8s-ci-robot 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 Jan 14, 2025

Danil-Grigorev force-pushed the oci-provider-source branch 3 times, most recently from 47baaa7 to 57b8b0b Compare January 17, 2025 10:43

k8s-ci-robot 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 Jan 17, 2025

Danil-Grigorev force-pushed the oci-provider-source branch from e9def7e to 4a773f8 Compare January 17, 2025 15:26

Danil-Grigorev changed the title ~~[WIP] ✨ Add OCI source for provider ConfigMap preparation~~ ✨ Add OCI source for provider ConfigMap preparation Jan 20, 2025

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 20, 2025

Danil-Grigorev force-pushed the oci-provider-source branch 8 times, most recently from bf81b3e to 2b3ca67 Compare January 24, 2025 13:38

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 24, 2025

Danil-Grigorev force-pushed the oci-provider-source branch from 2b3ca67 to efb530f Compare January 24, 2025 13:41

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 24, 2025

alexander-demicev approved these changes Jan 24, 2025

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 24, 2025

furkatgofurov7 reviewed Jan 27, 2025

View reviewed changes

Danil-Grigorev force-pushed the oci-provider-source branch 2 times, most recently from c0a51ad to 0f25329 Compare January 27, 2025 10:30

Danil-Grigorev force-pushed the oci-provider-source branch from 0f25329 to 3ca860e Compare January 27, 2025 11:52

Danil-Grigorev mentioned this pull request Jan 27, 2025

📖 Document OCI source usage, publish and preload subcommands #690

Merged

Danil-Grigorev added 6 commits January 27, 2025 14:10

Add OCI source for provider ConfigMap preparation

1a6adbf

Signed-off-by: Danil-Grigorev <[email protected]>

Add preload plugin command

304b67d

Signed-off-by: Danil-Grigorev <[email protected]>

Lint, doc fixes and refactoring

74196f4

Signed-off-by: Danil-Grigorev <[email protected]>

Populate ConfigMap kind

922808f

Signed-off-by: Danil-Grigorev <[email protected]>

Add publish subcommand

e543e4e

Signed-off-by: Danil-Grigorev <[email protected]>

Resolve files with duplicate content, add tests

2959930

Signed-off-by: Danil-Grigorev <[email protected]>

Danil-Grigorev force-pushed the oci-provider-source branch from 3ca860e to 2959930 Compare January 27, 2025 13:13

k8s-ci-robot assigned furkatgofurov7 Jan 27, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 27, 2025

k8s-ci-robot merged commit 6a31fe3 into kubernetes-sigs:main Jan 27, 2025
14 checks passed

Danil-Grigorev mentioned this pull request Jan 28, 2025

✨ Add IPAM provider support to Cluster API Operator Helm chart #688

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Add OCI source for provider ConfigMap preparation #683

✨ Add OCI source for provider ConfigMap preparation #683

Danil-Grigorev commented Jan 13, 2025 •

edited

Loading

netlify bot commented Jan 13, 2025 •

edited

Loading

alexander-demicev left a comment

alexander-demicev Jan 24, 2025

alexander-demicev Jan 24, 2025

Danil-Grigorev Jan 27, 2025

Danil-Grigorev Jan 27, 2025

alexander-demicev Jan 24, 2025

Danil-Grigorev Jan 27, 2025

alexander-demicev Jan 24, 2025

Danil-Grigorev Jan 27, 2025

k8s-ci-robot commented Jan 24, 2025

furkatgofurov7 left a comment •

edited

Loading

furkatgofurov7 commented Jan 27, 2025

furkatgofurov7 commented Jan 27, 2025

k8s-ci-robot commented Jan 27, 2025

✨ Add OCI source for provider ConfigMap preparation #683

✨ Add OCI source for provider ConfigMap preparation #683

Conversation

Danil-Grigorev commented Jan 13, 2025 • edited Loading

netlify bot commented Jan 13, 2025 • edited Loading

✅ Deploy Preview for kubernetes-sigs-cluster-api-operator ready!

alexander-demicev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 24, 2025

furkatgofurov7 left a comment • edited Loading

Choose a reason for hiding this comment

furkatgofurov7 commented Jan 27, 2025

furkatgofurov7 commented Jan 27, 2025

k8s-ci-robot commented Jan 27, 2025

Danil-Grigorev commented Jan 13, 2025 •

edited

Loading

netlify bot commented Jan 13, 2025 •

edited

Loading

furkatgofurov7 left a comment •

edited

Loading