Skip to content
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

📖clusterctl: doc config for air-gapped environments #2595

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
This PR document changes introduced by #2558 and by #2586

/assign @ncdc
/assign @vincepri

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 9, 2020
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved
Comment on lines 91 to 92
E.g. if you set the image tag for a provider components, e.g. the `infrastrcutrue-aws` provider, this most probably will lead to a not working management cluster because `kube-rbac-proxy` and
`cluster-api-aws-controller` usually are expected to have two different image tags.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
E.g. if you set the image tag for a provider components, e.g. the `infrastrcutrue-aws` provider, this most probably will lead to a not working management cluster because `kube-rbac-proxy` and
`cluster-api-aws-controller` usually are expected to have two different image tags.
Example: Let's say we're working with `infrastructure-aws`, overriding the image tag in the default provider components
is going to result in a non-functional cluster due to `kube-rbac-proxy` and `cluster-api-aws-controller` having different tags.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have dropped the example because it is hard to understand after moving the warning at the beginning of the paragraph

@fabriziopandini
Copy link
Member Author

@vincepri comment addressed

images:
all:
repository: myorg.io/local-repo
cert-manager:
Copy link
Contributor

Choose a reason for hiding this comment

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

can all component images be overridden? If not, would it make sense to provide a list of images that can be?

Copy link
Member Author

Choose a reason for hiding this comment

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

@CecileRobertMichon
ATM we are not supporting overrides for a single image, but only overrides at component level. In this example, "cert-manager" means all the images in the cert-manager manifest.

Available components are "cert-manger", "cluster-api" and all the installed providers: "bootstrap-kubeadm", "control-plane-kubeadm", "infrastracture-aws" etc.

Eventually, in the future/if there are specific needs, the mechanism can be extended for implementing image specific settings, but at the end the list of images depends on the provider manifests so it will be up to the provides to document which images are used.

all:
repository: myorg.io/local-repo
cert-manager:
tag: v0.11.1
Copy link
Contributor

Choose a reason for hiding this comment

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

Will the image specific override take precedence over the all setting?

Copy link
Member Author

Choose a reason for hiding this comment

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

@CecileRobertMichon
The override works union, with the most specific override config taking precedence on the all config in case of conflicts.

So, in this example:

  • for cluster-api images, the "all" override apply to all the images in the cluster-api manifest; same for other providers
  • for cert-manager images, the "all" override U the "cert-manager" override apply to all the images in the cert-manager manifest

@vincepri
Copy link
Member

/approve
/milestone v0.3.0

This seems it should go in now :)

@k8s-ci-robot k8s-ci-robot added this to the v0.3.0 milestone Mar 10, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini, vincepri

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 10, 2020
@CecileRobertMichon
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 10, 2020
@k8s-ci-robot k8s-ci-robot merged commit 762cb28 into kubernetes-sigs:master Mar 10, 2020
@fabriziopandini fabriziopandini deleted the clusterctl-doc-airgapped-config branch March 11, 2020 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants