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

🛠️ Make Hutch configuration guidance for installation clearer #12

Open
5 tasks
beforan opened this issue Jan 26, 2024 · 0 comments
Open
5 tasks

🛠️ Make Hutch configuration guidance for installation clearer #12

beforan opened this issue Jan 26, 2024 · 0 comments
Assignees
Labels
🛠️ backlog This issue is a planned work item

Comments

@beforan
Copy link
Member

beforan commented Jan 26, 2024

Summary

There are three parts to this:

  1. What is the clearest way we can document the required Hutch configuration depending on your chosen environment setup
    • e.g. What config do you need based on what prerequisite external components you're using
    • TRE-Controller needs X, MinIO needs Y, etc... but they're all optional
  2. Modifying the Ansible Service description should not be a preferred way to apply environment configuration, even when environment variables are used
    • There's no value to specifying the configuration before install time - in fact it puts more pressure on the prerequisite decisions and setup and implies they're more concrete than they actually are
    • It means changing config later is harder or more confusing as a person installing needs to know 2 config methods: one for Ansible and one for environment variables
    • it prevents the ability to use other config sources such as appsettings, if desirable.
  3. Documenting how you should do configuration (e.g. appsettings or env vars) and change it later, if Ansible isn't how.

Tasks

  • Remove environment configuration from Ansible Service Description for Hutch Agent
  • Update documentation to more clearly specify what config needs setting per given prerequisite components
  • Update documentation to more clearly explain how to set configuration initially and change it later

Acceptance Criteria

  • Ansible doesn't perform Hutch configuration
  • Documentation explains configuration approach when installing
@beforan beforan self-assigned this Jan 26, 2024
@beforan beforan changed the title Ansible shouldn't configure Hutch - Docs should be clearer about conditionally mandatory environment config [🛠️] Make Hutch configuration guidance for installation clearer Jan 26, 2024
@beforan beforan added the 🛠️ backlog This issue is a planned work item label Jan 26, 2024
@beforan beforan changed the title [🛠️] Make Hutch configuration guidance for installation clearer 🛠️ Make Hutch configuration guidance for installation clearer Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🛠️ backlog This issue is a planned work item
Projects
None yet
Development

No branches or pull requests

1 participant