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

Consider using a different key than example.com/project #2

Closed
etsauer opened this issue May 29, 2020 · 7 comments · Fixed by #17
Closed

Consider using a different key than example.com/project #2

etsauer opened this issue May 29, 2020 · 7 comments · Fixed by #17
Assignees
Labels
bug Something isn't working

Comments

@etsauer
Copy link
Contributor

etsauer commented May 29, 2020

No description provided.

@etsauer etsauer added the bug Something isn't working label Jun 4, 2020
@etsauer
Copy link
Contributor Author

etsauer commented Jun 8, 2020

@jkupferer what do you think of using the label example.com/directory?

@jkupferer
Copy link
Contributor

"Project" makes a lot of sense here if it were not for OpenShift already using the word for namespace
You said "component" was also not available because that means something else

I think what we want is something that conveys something like what is this part of, what declarative config "owns" this thing.

I don't think "directory" captures that idea.

When in doubt, I usually just go with a longer name: example.com/declarative-config?

@etsauer
Copy link
Contributor Author

etsauer commented Jun 8, 2020

@jkupferer yeah, so "component" is currently being used to describe the level below "project", however that could also be debated.

So currently, it looks like this:

$ tree simple-bootstrap/
simple-bootstrap/ # example.com/project=simple-bootstrap
├── 0-namespaces # example.com/component=namespaces
│   ├── cluster-ops.yaml
│   ├── deleteable.yaml
│   └── namespace-config-operator.yaml
├── 1-operators # example.com/component=operators
│   └── namespace-config-operator.yaml
├── 2-rbac # example.com/component=rbac
│   └── cluster-admins-rolebinding.yaml
└── 3-operator-configs # example.com/component=operator-config
    ├── gitops-job.yaml
    └── sandbox-userconfig.yaml

I'm open to renaming both of those keys.

@jkupferer
Copy link
Contributor

jkupferer commented Jun 9, 2020

What about config.example.com/name for the top level which should reflect the name configuration repository? and config.example.com/component for the next level?

@etsauer
Copy link
Contributor Author

etsauer commented Jun 9, 2020

Interesting... would you change the annotation prefixes to config.example.com as well or leave them as they are?

@jkupferer
Copy link
Contributor

I would change those too. I believe it fits established pattern to use subdomains like this?

@etsauer
Copy link
Contributor Author

etsauer commented Jun 9, 2020

ok, I'm cool with this. Will open a PR.

etsauer added a commit to etsauer/declarative-openshift that referenced this issue Jun 9, 2020
jkupferer added a commit that referenced this issue Jun 10, 2020
Change labels to new format based on issue #2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants