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

Update snippets and templates #21

Open
TomerFi opened this issue Nov 23, 2022 · 2 comments
Open

Update snippets and templates #21

TomerFi opened this issue Nov 23, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@TomerFi
Copy link
Member

TomerFi commented Nov 23, 2022

Updating the snippets and templates technically means updating the versions and validating existing annotations and spec keys based on the updated CRDs.

But I think we're currently missing some spec keys and annotations that might be helpful to users and perhaps worth adding to the snippets and templates, so this all can be part of this task and can be divided to multiple PRs for multiple developers.

We can use this issue to track links to CRDs we're working with and discuss what we want to include in the snippets and templates.

@TomerFi
Copy link
Member Author

TomerFi commented Nov 23, 2022

To illustrate the goal of this task, note this self-explanatory warning from a random deploy process:

Warning: cluster.open-cluster-management.io/v1beta1 ManagedClusterSetBinding is deprecated;
use cluster.open-cluster-management.io/v1beta2 ManagedClusterSetBinding

To avoid this specific warning in deployment based on our snippets or templates, we need to:

1- Update the various templates, i.e. the Git Subscription template.

2- Add a new snippets here, i.e. :

{
	"managedclustersetbinding-v1beta1": {
            ...
	},
	"managedclustersetbinding-v1beta2": {
            ...
	}
}

In regards to the snippets, we should also decide whether or not we want to keep the old v1beta1 version.

I think this is the CRD for ManagedClustersetBinding.

@TomerFi
Copy link
Member Author

TomerFi commented Nov 23, 2022

To illustrate the second goal of this task, we can take a look at the Subscription CRD, we can see properties such as overrides, packageFilter, and packageOverrides which has little to no representation in our snippets.

This is just an example, other resource kinds has other missing properties that might be useful to users.
We can discuss different properties for different kinds and decide together which, if any, we want to include in our snippets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant