Skip to content

Gefyra Config File #863

@SteinRobert

Description

@SteinRobert

What is the new feature about?

Gefyra commands often are very long. Also often you need to chain multiple commands. Same commands over and over again. We're seeing people writing their commands into the README.md or other markdown docs.

Since we've added and will add more functionality to Gefyra I propose a Gefyra config file - similar to docker-compose.yaml. It contains a configuration to start your setup with one command e.g. gefyra launch project.gefyra.yaml.
Question - should we support something like gefyra shutdown project.gefyra.yaml to also shutdown a setup?

Use cases:

  • consistent run configuration
  • share config with colleagues
  • run + bridge in one command

How are the files structured?

I'd propose yaml since it has become a very common format in the container/k8s world to write configurations. It would probably help to formally define a JSON schema first, which then helps with validation (maybe use pydantic).

There are essentially 3 sections that are relevant:

  1. the client to connect (maybe optional?)
  2. the run config
  3. the bridge config (optional)

The client connect part - maybe this can be standardized (always access .gefyra.json) so this part could be more or less optional.

Bonus: Generate cli commands from gefyra config file for quick modification.

The cli command - should check whether all condition to execute the action successfully are met (like --env-from deploy/c is available, namespace available...).

cc @Schille

Why would such a feature be important to you?

More efficient workflows. Share knowledge and configs with colleagues.

Anything else we need to know?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions