crossplane / crossplane/docs

Install packages as `<org-name-package-name>` by convention

Open
#726 0 comments 0 reactions 0 assignees View on GitHub
concepts/packages
Dominant language
SCSS
Stars
60
Forks
163
Avg merge
15h 20m
Merged PRs (30d)
9

Description

### What's Missing?

Most of our documentation and examples use names like `provider-aws-s3` and `function-patch-and-transform` when installing packages. See for example https://docs.crossplane.io/v1.15/getting-started/provider-aws/#install-the-aws-provider.

When the package manager installs a package because another package depends on it, it uses a different naming scheme. It includes the OCI org name. For example it installs `xpkg.upbound.io/upbound/provider-aws-s3` as `upbound-provider-aws-s3`, not `provider-aws-s3`. It does this to avoid conflicts between two identically named but different packages. For example `xpkg.upbound.io/upbound/function-foo` and `index.docker.io/acmeco/function-foo` could be completely different functions that happen to have the same name. Including the org name allows both to be installed at once.

This can sometimes be confusing. People are accustomed to using the the "unqualified" package name. They might run `kubectl get provider provider-aws` and think that the provider isn't installed, when in fact it is installed as `upbound-provider-aws`. Similarly, they might reference `function-foo` from a Composition when in fact they should reference `crossplane-contrib-function-foo`.

I think the package manager is doing the right thing here, but I'd like to remove the inconsistency in naming. One way to do that would be to move our documentation and examples toward using the same naming scheme as the package manager.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.