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.

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

Compatibility: unify providers and base on CAPI contract versions #525

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Compatibility: unify providers and base on CAPI contract versions #525

merged 3 commits into from
Oct 24, 2024

Conversation

zerospiel
Copy link
Member

@zerospiel zerospiel commented Oct 18, 2024 •
edited
Loading

  • removed nested struct with infra/bstrp/cp providers
  • migrated provider/cluster templates on the new annotation
  • unified flat providers structure
  • unified separated capi contracts struct for cluster/provider templates
  • compatibility is now based on CAPI contract versions
  • change semicolon to comma as a separator in the provider templates charts
  • capi contracts status in management status
  • provider templates: validate capi contracts against core capi template
  • cluster templates: validate provider contracts against provider templates contracts in management status
  • renamed k0s -> k0smotron everywhere

In conclusion:

Core CAPI compatibility contracts:

annotations:
  cluster.x-k8s.io/v1beta1: ""
  cluster.x-k8s.io/v1alpha3: ""
  cluster.x-k8s.io/v1alpha4: ""

An example of compatibility attributes annotations along with the new provider annotation in a chart for the ProviderTemplate:

annotations:
  cluster.x-k8s.io/provider: infrastructure-aws
  cluster.x-k8s.io/v1alpha3: v1alpha3
  cluster.x-k8s.io/v1alpha4: v1alpha4
  cluster.x-k8s.io/v1beta1: v1beta1_v1beta2

An example of compatibility attributes annotations along with the new provider annotation in a chart for the ClusterTemplate:

annotations:
  cluster.x-k8s.io/provider: infrastructure-aws, control-plane-k0smotron, bootstrap-k0smotron
  cluster.x-k8s.io/v1beta1: v1beta1_v1beta2

New Management status block:

  status:
    availableProviders: # now deduplicated and sorted
    - bootstrap-k0smotron
    - control-plane-k0smotron
    - infrastructure-aws
    - infrastructure-azure
    - infrastructure-k0smotron
    - infrastructure-vsphere
    capiContracts: # map[<provider-name>]map[<capiContract>]<providerContract>
      infrastructure-aws:
        v1alpha3: v1alpha3
        v1alpha4: v1alpha4
        v1beta1: v1beta1_v1beta2

New ProviderTemplate status in the core-capi:

status:
  capiContracts:
    v1alpha3: ""
    v1alpha4: ""
    v1beta1: ""
  chartRef: # old 
    kind: HelmChart
    name: cluster-api-0-0-2
    namespace: hmc-system

New ProviderTemplate status in some object:

status:
  capiContracts:
    v1alpha3: v1alpha3
    v1alpha4: v1alpha4
    v1beta1: v1beta1_v1beta2
  chartRef:
    kind: HelmChart
    name: cluster-api-provider-aws-0-0-2
    namespace: hmc-system
# ... 
  providers:
  - infrastructure-aws

New ClusterTemplate status in some object:

status:
  capiContracts:
    v1beta1: v1beta1_v1beta2
  chartRef:
    kind: HelmChart
    name: aws-hosted-cp-0-0-2
    namespace: hmc-system
# ... 
  providers:
  - infrastructure-aws
  - control-plane-k0smotron
  - bootstrap-k0smotron

Closes #497 #496

@zerospiel zerospiel force-pushed the providers_alignment branch from 91f2165 to 4f6692c Compare October 18, 2024 11:57
@zerospiel zerospiel marked this pull request as ready for review October 18, 2024 12:06
@zerospiel zerospiel force-pushed the providers_alignment branch 6 times, most recently from 1ff639b to dfc3bc0 Compare October 18, 2024 15:55
@zerospiel zerospiel requested a review from squizzi as a code owner October 18, 2024 16:03
@zerospiel zerospiel changed the title Align provider names with the CAPI labels Compatibility: unify providers and base on CAPI contract versions Oct 18, 2024
@zerospiel zerospiel force-pushed the providers_alignment branch 5 times, most recently from 55e7f21 to 5c0d401 Compare October 21, 2024 09:01
@zerospiel zerospiel linked an issue Oct 21, 2024 that may be closed by this pull request
Providers/Templates compatibility based on contracts instead of versions #496
Closed
@zerospiel zerospiel force-pushed the providers_alignment branch from 5c0d401 to b03b9b3 Compare October 22, 2024 09:11
Kshatrix
Kshatrix requested changes Oct 22, 2024
View reviewed changes
api/v1alpha1/providertemplate_types.go Outdated Show resolved Hide resolved
api/v1alpha1/providertemplate_types.go Outdated Show resolved Hide resolved
api/v1alpha1/providertemplate_types.go Outdated Show resolved Hide resolved
api/v1alpha1/templates_common.go Outdated Show resolved Hide resolved
api/v1alpha1/providertemplate_types.go Outdated Show resolved Hide resolved
@zerospiel zerospiel force-pushed the providers_alignment branch from 5db67b8 to 706e684 Compare October 22, 2024 21:17
@zerospiel zerospiel requested a review from Kshatrix October 22, 2024 21:20
@zerospiel zerospiel force-pushed the providers_alignment branch from 706e684 to ba9ff0a Compare October 23, 2024 13:12
@zerospiel zerospiel mentioned this pull request Oct 23, 2024
Closed
@zerospiel zerospiel force-pushed the providers_alignment branch 2 times, most recently from a760f82 to 857f4dd Compare October 23, 2024 13:22
@zerospiel zerospiel force-pushed the providers_alignment branch from 857f4dd to a1c1bc1 Compare October 23, 2024 13:29
@zerospiel zerospiel requested a review from eromanova October 23, 2024 13:44
@zerospiel
Align provider names with the CAPI labels
a3c0cf2 
* removed nested struct with infra/bstrp/cp
  providers
* removed the corresponding chart annotations
* align all providers into a single struct
  depending on a single annotation
  with regarding prefixes
* migrated provider/cluster templates on the
  new annotation

Closes Mirantis#497
@zerospiel
Introduce compatibility based on contracts
92e00c1 
* removed version/constraints from compatibility
  attributes
* compatibility is now based on CAPI contracts
  versions
* unified providers structure
* corresponding adjustments

Closes Mirantis#496
@zerospiel
Compatibility rework: addressed comments
ad9af28 
* change semicolon to comma as a separator
  in the provider templates charts
* capi-contract annotation removed
* unified separated capi contracts struct
  for cluster/provider templates
* capi contracts status in management status
* provider templates: validate capi contracts
  against core capi template
* cluster templates: validate provider contracts
  against provider templates contracts in management status
* renamed k0s -> k0smotron everywhere
@zerospiel zerospiel force-pushed the providers_alignment branch from a1c1bc1 to ad9af28 Compare October 24, 2024 06:20
@Kshatrix Kshatrix merged commit 59a0e13 into Mirantis:main Oct 24, 2024
5 checks passed
@zerospiel zerospiel deleted the providers_alignment branch October 24, 2024 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eromanova eromanova eromanova approved these changes

@Kshatrix Kshatrix Kshatrix approved these changes

@a13x5 a13x5 Awaiting requested review from a13x5 a13x5 is a code owner

@squizzi squizzi Awaiting requested review from squizzi

Assignees
No one assigned
Labels
None yet
Projects
Project 2A
Status: Done
Milestone
No milestone
3 participants
@zerospiel @Kshatrix @eromanova