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.

Sign up for GitHub

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

Jump to bottom

Further name changes of 'Tackle' to 'Konveyor' #198

Open
jwmatthews opened this issue Apr 14, 2023 · 7 comments
Open

Further name changes of 'Tackle' to 'Konveyor' #198

jwmatthews opened this issue Apr 14, 2023 · 7 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@jwmatthews
Copy link
Member

jwmatthews commented Apr 14, 2023 •
edited
Loading

Continuing with the work to change from 'Tackle' to 'Konveyor'.
Let's make the below changes so we capture the higher level of what is deployed is Konveyor for consistency:

  • Update this repository from 'tackle2-operator' to 'konveyor-operator'
  • Update the 'CR' from 'Tackle' to 'Konveyor'
  • Update the role from 'tackle' to 'konveyor'
  • Update the namespace to be 'konveyor' from 'konveyor-tackle'
  • Update the deployment 'tackle-operator' to 'konveyor-operator'

After this, I am unsure how far to go. Let's at least consider and think through the below.

Questions:

  • Do we want to go deeper with name changes and update the other components?
    • konveyor-ui from tackle-ui, konveyor-hub from tackle-hub, etc
    • ingress of 'tackle' or 'konveyor', etc
  • How far do we take this?
    • What about the API group 'tackle.konveyor.io'
@aufi
Copy link
Member

aufi commented Apr 14, 2023 •
edited
Loading

Do we want to go deeper with name changes and update the other components?

  • konveyor-ui from tackle-ui, konveyor-hub from tackle-hub, etc

If we'd change component names, it might make sense don't use prefixed names, so the names change could be:
tackle2-ui -> ui (repo github.com/konveyor/ui)
tackle2-hub -> hub (repo github.com/konveyor/hub)
...

@jmontleon
Copy link
Member

jmontleon commented Apr 14, 2023 •
edited
Loading

Changing the CR is going to be the most disruptive of the above. If we want to change API Group I vote we do it at the same time otherwise we're going to hit this twice. And we should probably do it sooner and just get it over with so we can stabilize on the new ones.

I'm not sure if the namespace change will inflict any pain other than we'll probably have to make sure it works in both (and upgrades in both, I'm not sure if we change the namespace and then have OwnNamespace as the only option if we cause pain for existing installs https://github.com/konveyor/tackle2-operator/blob/main/bundle/manifests/konveyor-operator.clusterserviceversion.yaml#L339-L342, we might need to add SingleNamespace).

The repo name change probably isn't too painful.

I think the deployment name change and role name change should be painless.

@jwmatthews
Copy link
Member Author

I could see the API Group is excessive and not needed, worth talking out and seeing what folks think though.

@jwmatthews jwmatthews mentioned this issue May 1, 2023
Closed
@kaovilai kaovilai mentioned this issue May 2, 2023
Merged
jmontleon pushed a commit that referenced this issue Jun 6, 2023
@kaovilai
🌱 Update config/ so make bundle can update bundle/ (#216)
5f8babf 
👻 simplified tools/tackle-opdev.sh with `make bundle`
:bug: `docker-build`, `bundle-build` fixes for docker where `--arch` is
invalid

:seedling: `make deploy-olm` to run local unpublished changes from
source installed with a new bundle.
- replicate behavior of installing from OperatorHub giving you better
idea of what the CSV, CRDs, RBACs, from the `bundle/` looks like in the
cluster rather than just creating a simple deployment or replacing the
deployment image.
- TL;DR `make podman-build podman-push bundle bundle-build bundle-push`
using ttl.sh registry (no auth required)

Goal: minimize functional changes and allow for `make bundle` command to
work using info from `config/`

```sh
diff <(curl -s https://raw.githubusercontent.com/konveyor/tackle2-operator/main/bundle/manifests/konveyor-operator.clusterserviceversion.yaml | yq -P 'sort_keys(..)') <(curl -s https://raw.githubusercontent.com/kaovilai/tackle2-operator/configmakefile-update/bundle/manifests/konveyor-operator.clusterserviceversion.yaml | yq -P 'sort_keys(..)')
```

minimal semantic diff when running through https://yamldiff.com/
- `curl
https://raw.githubusercontent.com/konveyor/tackle2-operator/main/bundle/manifests/konveyor-operator.clusterserviceversion.yaml
| yq -P 'sort_keys(..)'`
- `curl
https://raw.githubusercontent.com/kaovilai/tackle2-operator/configmakefile-update/bundle/manifests/konveyor-operator.clusterserviceversion.yaml
| yq -P 'sort_keys(..)'`


noop `bundle/` changes
- side-effect of operator-sdk generate bundle
    - yaml keys are now sorted from a to z
    - long string values are broken up into multiple lines
    - `>+` `|+` no longer has `+`

other `bundle/` changes
- 🌱 CSV name change: `tackle-operator.v99.0.0` -->
`konveyor-operator.v99.0.0`
- operator-sdk requires CSV and file names to match the
[projectName](https://github.com/konveyor/tackle2-operator/blob/0c18e4fdde3de1ad148dcad9d9eb4ab269ba5b03/PROJECT#L7)
        - alternative is to change projectName to tackle-operator
    - Partial requirement of #198
- relatedImages in CSV is now generated from manager Env
`RELATED_IMAGE_<>` with prefix removed, lowercased:
  - new relatedImages:
      - `oauth-proxy` previously not in CSV.
  - renamed relatedImages:
      - `tackle-addon` --> `addon-admin`
      - `tackle-addon-windup` --> `addon-windup`
      - `tackle-pathfinder` --> `pathfinder`
      - `tackle-keycloak` --> `keycloak-sso`
      - `tackle-keycloak-init` --> `keycloak-init`
- 🌱 renamed manager Env:
    - `RELATED_IMAGE_TACKLE_POSTGRES` replaces
        -  `RELATED_IMAGE_KEYCLOAK_DATABASE`
        - `RELATED_IMAGE_PATHFINDER_DATABASE`
    - solves
        ```
WARN[0000] warning: multiple related images with the same image ref,
"pathfinder-database", and different names found.The image will only be
listed once with an empty name.It is recmmended to either remove the
duplicate or use the exact same name.
        ```

While this is in draft, you may see some deletions in this PR which are
a result of outdated config/ and will be resolved before coming out of
draft..

Closes #201 

Signed-off-by: Tiger Kaovilai <[email protected]>

---------

Signed-off-by: Tiger Kaovilai <[email protected]>
Signed-off-by: Tiger Kaovilai <[email protected]>
@savitharaghunathan savitharaghunathan mentioned this issue Jul 3, 2023
Closed
@djzager
Copy link
Member

djzager commented Feb 14, 2024

/triage accepted
/priority important-longterm
/kind documentation
/kind feature

@konveyor-ci-bot konveyor-ci-bot bot added kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Feb 14, 2024
@jortel
Copy link
Contributor

jortel commented Mar 11, 2024

I'm still opposed to this.
There are 80 repositories in konveyor and tackle2- prefix is the only way to easily identify what constitutes the tackle application.

@djzager
Copy link
Member

djzager commented Mar 11, 2024

I was of the understanding that it was still an open question if we go around dropping the tackle(2)- prefix. That what could be done and warrants prioritization is:

  • Update the 'CR' from 'Tackle' to 'Konveyor' ... this has api compatibility concerns
  • Update the role from 'tackle' to 'konveyor' ... this would likely be transparent to any user
  • Update the namespace to be 'konveyor' from 'konveyor-tackle' ... would need to make sure that this doesn't break existing installs, and isn't this partly a documentation issue where we tell users to install our operator?
  • Update the deployment 'tackle-operator' to 'konveyor-operator' ... already done

@dymurray
Copy link
Contributor

dymurray commented Mar 12, 2024 •
edited
Loading

+1, ignoring the repo prefix (though I would want to consider removing tackle2 as much as possible and that probably includes cleaning up our organization so it's not confusing which repo is which to Jeff's point), the CR and operator/CSV changes should be prioritized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Planning
Status: 📋 Backlog
Milestone
No milestone
Development

No branches or pull requests
6 participants
@jwmatthews @aufi @djzager @jortel @jmontleon @dymurray