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

🌱 Tiltfile: Parameterize kustomize and main.go for providers #3604

Merged
merged 2 commits into from
Sep 9, 2020

Conversation

maelk
Copy link
Contributor

@maelk maelk commented Sep 8, 2020

What this PR does / why we need it:

This comes from a need in Metal3. The CAPM3 provider contains for now three controllers, each of them in a separate repository. Only the main repository (the CAPM3 controller) contains a ./config folder that should be applied, and that includes the the two other controllers. It is currently possible to develop CAPM3 using CAPI tiltfile but that limits us to working with CAPM3 only, as the two other controllers repositories are not considered. If the Tiltfile was not trying to build the ./config folder of all providers, those two other repositories could be given as additional providers to allow development there too. In addition, when the provider is not built using Kubebuilder, but an old version of operator-sdk for example, the main.go file is not located at the root of the repository.

This PR adds a configuration field to be able to disable the kustomize step of the Tiltfile. It allows the user to prevent running kustomize on the ./config folder by setting the kustomize_config boolean field in the tilt-provider.json file. It also allows the user to provide a specific main.go file for the provider. For example:

{
    "name": "bmo",
    "config": {
        "kustomize_config": false,
        "go_main": "cmd/manager/main.go",
        "image": "quay.io/metal3-io/baremetal-operator",
        "live_reload_deps": [
            "cmd", "pkg"
        ]
    }
}

In some cases the providers listed might not have a ./config
folder, or the config should not be applied. This commit allows
the user to prevent running kustomize on the ./config folder
by setting the `kustomize_config` boolean field in the
tilt-provider.json file. For example:

```json
{
    "name": "aws",
    "config": {
        "kustomize_config": false,
        "image": "gcr.io/k8s-staging-cluster-api-aws/cluster-api-aws-controller",
        "live_reload_deps": [
            "main.go", "go.mod", "go.sum", "api", "cmd", "controllers", "pkg"
        ]
    }
}
```
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 8, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @maelk. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 8, 2020
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 8, 2020
@maelk
Copy link
Contributor Author

maelk commented Sep 8, 2020

/assign @justinsb

@fabriziopandini
Copy link
Member

/ok-to-test
/milestone v0.3.10

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Sep 8, 2020
@k8s-ci-robot k8s-ci-robot added this to the v0.3.10 milestone Sep 8, 2020
@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 8, 2020
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 8, 2020
@fabriziopandini
Copy link
Member

It seems there are som lint issues to be fixed run make format-tiltfile to fix the errors

In some cases (if built with an older operator-sdk version for example)
there might not be a main.go at the root of the repository of a
provider. This change allows the user to specify its go main file with
the option "go_main" in the tilt provider file, such as

```json
{
    "name": "bmo",
    "config": {
        "kustomize_config": false,
        "go_main": "cmd/manager/main.go",
        "image": "quay.io/metal3-io/baremetal-operator",
        "live_reload_deps": [
            "cmd", "pkg"
        ]
    }
}
```
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 8, 2020
@maelk
Copy link
Contributor Author

maelk commented Sep 8, 2020

@fabriziopandini thank you for the note. I fixed the format.

@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 8, 2020
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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 Sep 9, 2020
@k8s-ci-robot k8s-ci-robot merged commit 73624ed into kubernetes-sigs:master Sep 9, 2020
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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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