Symlinks and code generator

kvaps commented 2 years ago

Preflight Checklist

[X] I agree to follow the Code of Conduct that this project adheres to.
[X] I have searched the issue tracker for an issue that matches the one I want to file, without success.

Use case. Why is this important?

I purpose to get rid of /deckhouse symlink and move symlinks management to specific generator.

Better DX:

You don't need to modify system to setup /deckhouse symlink in root of the system
Ability to run tests locally without any additional preparation
Ability to use git subtree plugin

Proposed Solution

We need to put specific anchor file into root of the project, eg: .deckhouse_root and write a new go generator.

There are a few places which might have an automatic update:

symlinks to helm_lib and candi (which can be detected by name)
symlinks for node-manager to cloud-providers (we can add specific logic)
go hooks, mainly ensure_crds.go and others + tests

For the last ones I suggest using go/parser and go/ast to automatically manage relative path for deckhouse. Each file should include a new constant which will be generated automatically:

// +deckhouse-gen:root
const deckhouseRoot = "../../.."

then it can be used as usual:

var _ = ensure_crds.RegisterEnsureCRDsHook(deckhouseRoot + "/modules/101-cert-manager/crds/*.yaml")

Additional Information

No response

stale[bot] commented 1 year ago

This issue has been automatically put in the triage queue because it has not had recent activity. The team will reconsider the status of this issue. Thank you for your contributions.

EvgenySamoylov commented 1 year ago

We are working on the 3rd party modules, which will reduce the number of symlinks.

deckhouse / deckhouse