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

Add load-pkg to the makefile and add the development guide link to README #361

Merged
merged 6 commits into from
May 10, 2024

Conversation

turkenf
Copy link
Collaborator

@turkenf turkenf commented Aug 14, 2023

Description of your changes

This PR adds load-pkg dev make target to the makefile.

Fixes: #309

I have:

  • Run make reviewable test to ensure this PR is ready for review.

How has this code been tested

  • Run the following command:
make load-pkg PROVIDERS="cloudplatform container" REPO="index.docker.io/turkenf"
  • After the above command is completed:
> docker image ls
REPOSITORY                                 TAG                         IMAGE ID       CREATED        SIZE
turkenf/provider-family-gcp-amd64          v1.1.0-rc.0.42.g42cf069b9   baac1f7e697d   6 weeks ago    179MB
turkenf/provider-gcp-cloudplatform-amd64   v1.1.0-rc.0.42.g42cf069b9   fe2106877bf9   6 weeks ago    181MB
turkenf/provider-gcp-container-amd64       v1.1.0-rc.0.42.g42cf069b9   94f8d11c2709   6 weeks ago    181MB
turkenf/provider-gcp-cloudplatform-arm64   v1.1.0-rc.0.42.g42cf069b9   edbf18e9d01f   6 weeks ago    176MB
turkenf/provider-gcp-container-arm64       v1.1.0-rc.0.42.g42cf069b9   0d3ab205ef66   6 weeks ago    176MB
turkenf/provider-family-gcp-arm64          v1.1.0-rc.0.42.g42cf069b9   a6ef52d83555   6 weeks ago    175MB

Installable images for the family config provider created by default.

  • Manually tested and installed config and cloudplatform packages in local cluster:
> kubectl get providers.pkg.crossplane.io
NAME                                 INSTALLED   HEALTHY   PACKAGE                                                                              AGE
upbound-provider-gcp-cloudplatform   True        True      index.docker.io/turkenf/provider-gcp-cloudplatform-arm64:v1.1.0-rc.0.42.g42cf069b9   115s
upbound-provider-gcp-config          True        True      index.docker.io/turkenf/provider-family-gcp-arm64:v1.1.0-rc.0.42.g42cf069b9          115s

@turkenf turkenf changed the title Add load-pkg to the makefile and add the development guide. Add load-pkg to the makefile and add the development guide link to README Aug 14, 2023
Copy link
Collaborator

@ulucinar ulucinar left a comment

Choose a reason for hiding this comment

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

Thanks @turkenf, lgtm. Left some comments for you to consider. As discussed offline, we may consider surfacing the XPKG_REG_ORGS Make variable as it affects the family config provider dependency generated in the resource provider's metadata and has the potential to simplify the installation step because users will not have to deal with the config provider dependency. Please see this.

README.md Outdated
@@ -30,6 +30,10 @@ If you'd like to learn how to use Upjet, see [Usage Guide](https://github.com/up

Follow the guide [here](https://github.com/upbound/upjet/blob/main/docs/add-new-resource-short.md).

### Local Development

For building provider images locally, follow the guide [here](https://github.com/upbound/upjet/blob/main/docs/buliding-provider-images.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
For building provider images locally, follow the guide [here](https://github.com/upbound/upjet/blob/main/docs/buliding-provider-images.md).
For building provider images locally, follow the guide [here](https://github.com/upbound/upjet/blob/main/docs/building-provider-images.md).

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
@turkenf
Copy link
Collaborator Author

turkenf commented Sep 22, 2023

/test-examples="examples/cloudplatform/serviceaccount.yaml"

@turkenf
Copy link
Collaborator Author

turkenf commented Dec 7, 2023

/test-examples="examples/bigquery/connection.yaml"

Copy link
Collaborator

@ulucinar ulucinar left a comment

Choose a reason for hiding this comment

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

Thank you @turkenf for improving the developer experience. Building an (installable) provider package for the provider families has been a constant confusion point for these repos. Hopefully this will simplify the process for the provider developers.

We also need to document this new target. A section in the repo's README.md would be easy to discover for the newcomers. I would also suggest a new section, such as Development, in the marketplace docs.

Could you also please add an example run of the new target in the PR description?

Makefile Show resolved Hide resolved
Makefile Show resolved Hide resolved
@turkenf turkenf merged commit 04280bf into crossplane-contrib:main May 10, 2024
8 of 9 checks passed
@turkenf turkenf deleted the add-load-pkg branch May 10, 2024 12:10
Copy link

Successfully created backport PR #523 for release-1.1.

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.

Add a new make target to build and load service-scoped provider images
2 participants