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 conventions #23

Merged
merged 1 commit into from
Apr 7, 2022
Merged

Add conventions #23

merged 1 commit into from
Apr 7, 2022

Conversation

scothis
Copy link
Contributor

@scothis scothis commented Mar 29, 2022

Cartographer Conventions is a new component that is part of
Cartographer. Adding the latest release of the conventions to the
exiting cartographer package. The version numbers for each component are
distinct and intended to drift. All resources are installed into the
cartographer-system namespace.

There are two user facing values:

  • ca_cert_data allows users to trust additional ca certificates, which
    are commonly used inside corporate networks for internal image
    registries.
  • excluded_components a list of components that should not be
    installed. The only valid values at the moment are conventions and
    `cartographer.

There are a handful of places where cartographer and cartographer
conventions have different behavior that we can iron out over time. They
include:

  • image pull secrets - conventions defines the secret and injects the
    pull secret reference inside the bundle.
  • aggregated roles - cartographer conventions can drop their inline
    roles now that the aggregated values are defined in package.

Signed-off-by: Scott Andrews andrewssc@vmware.com

@scothis scothis force-pushed the add-conventions branch 2 times, most recently from 299e9d4 to ef7b81d Compare March 29, 2022 15:53
@scothis scothis marked this pull request as ready for review March 29, 2022 15:59
@scothis
Copy link
Contributor Author

scothis commented Mar 29, 2022

CI isn't configured to run for PRs, but you can see the push run from my fork https://github.com/scothis/package-for-cartographer/runs/5740260605?check_suite_focus=true

src/cartographer/config/overlays/image-pull-secret.yaml Outdated Show resolved Hide resolved
tests/01-test-convention.sh Outdated Show resolved Hide resolved
tests/01-test-convention.sh Outdated Show resolved Hide resolved
tests/01-test-convention.yaml Show resolved Hide resolved
@scothis scothis force-pushed the add-conventions branch 2 times, most recently from d835261 to 13461e5 Compare March 30, 2022 18:16
@scothis scothis requested a review from cirocosta March 30, 2022 22:51
cirocosta pushed a commit to vmware-tanzu/cartographer that referenced this pull request Apr 6, 2022
in order to make the installation of Cartographer in carvel-based
packaging easier, we used to have this secret that gets filled by
secretgen-controller as part of the set of objects shipped in the
release, but given that it's such a packaging-specific detail, here we
get rid of it favoring `package-for-cartographer` as the location for
doing so.

see vmware-tanzu/package-for-cartographer#23 for
the PR where that addition of a secret to the package takes place (file:
src/cartographer/config/overlays/image-pull-secret.yaml)

Signed-off-by: Ciro S. Costa <ciroscosta@vmware.com>
Copy link
Contributor

@cirocosta cirocosta left a comment

Choose a reason for hiding this comment

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

lgtm! to carto, just submitted pr for removing placeholder secret

src/cartographer/config/overlays/excluded-components.yaml Outdated Show resolved Hide resolved
Cartographer Conventions is a new component that is part of
Cartographer. Adding the latest release of the conventions to the
exiting cartographer package. The version numbers for each component are
distinct and intended to drift. All resources are installed into the
cartographer-system namespace.

There are two user facing values:
- `ca_cert_data` allows users to trust additional ca certificates, which
  are commonly used inside corporate networks for internal image
  registries.
- `excluded_components` a list of components that should not be
  installed. The only valid values at the moment are `conventions` and
  `cartographer.

There are a handful of places where cartographer and cartographer
conventions have different behavior that we can iron out over time. They
include:

- image pull secrets - conventions defines the secret and injects the
  pull secret reference inside the bundle.
- aggregated roles - cartographer conventions can drop their inline
  roles now that the aggregated values are defined in package.

Signed-off-by: Scott Andrews <andrewssc@vmware.com>
@scothis scothis requested a review from cirocosta April 6, 2022 23:49
cirocosta pushed a commit to vmware-tanzu/cartographer that referenced this pull request Apr 7, 2022
- config: remove placeholder secret

in order to make the installation of Cartographer in carvel-based
packaging easier, we used to have this secret that gets filled by
secretgen-controller as part of the set of objects shipped in the
release, but given that it's such a packaging-specific detail, here we
get rid of it favoring `package-for-cartographer` as the location for
doing so.

see vmware-tanzu/package-for-cartographer#23 for
the PR where that addition of a secret to the package takes place (file:
src/cartographer/config/overlays/image-pull-secret.yaml)


- docs: remove placeholder secret

when installing cartographer, such object is not included anymore, so it
wouldn't show up in the list of objects that kapp is managing


- packaging: remove everything packaging related

any carvel packaging related to cartographer now takes place under
`vmware-tanzu/package-for-cartographer`, so, get rid of this leftover.


- hack: remove registry authentication

we used to bring up the registry with authentication enabled so that we
could be sure that the packaging work was right w/ regards to providing
credentials via secretgen's placeholder secrets, but now that such
responsability has shifted towards the packaging efforts under
`vmware-tanzu/package-for-cartographer`, we can now get rid of this
requirement from this repository


- hack: remove registry creds from examples setup

with the registry used by those not requiring any more auth, we can get
rid of those credentials from the setup.


- hack: remove references to registry-auth

with the removal of the need for authenticating against the registry
where we publish the release of cartographer, we can now skip all the
references to the previously `hack/registry-auth` directory where a
secretexport was placed for the credentials to the local registry

Signed-off-by: Ciro S. Costa <ciroscosta@vmware.com>
@cirocosta cirocosta merged commit 286b2c9 into vmware-tanzu:main Apr 7, 2022
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.

3 participants