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

Add operate value docs #143

Merged
merged 4 commits into from
Feb 2, 2022
Merged

Add operate value docs #143

merged 4 commits into from
Feb 2, 2022

Conversation

Zelldon
Copy link
Member

@Zelldon Zelldon commented Feb 1, 2022

  • Replaces some variables with already defined global ones.
  • Rename properties to be aligned with other names (created -> enabled)
  • Document operate values, following the https://github.com/camunda-community-hub/camunda-cloud-helm/blob/main/CONTRIBUTING.md#documentation
  • Move operate values to parent values.yaml file. To reduce duplication and avoid drifting away (values). Values are specified and documented in the parent values.yaml file, this will overwrite anyway values from the subchart. This should create one single place of truth we only need to manage.

related to #124

Rename serviceAccount.created to serviceAccount.enabled to align with other variable names
To reduce duplication and avoid drifting away (values) values are specified and documented in the parent values.yaml file. This will overwrite anyway values from the subchart. This creates one single place of truth we only need to manage.
Copy link
Member

@npepinpe npepinpe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

I assume there will be a follow up at some point to document everything in the README?

# Logging configuration for the operate logging. This template will be directly included in the operate configuration yaml file
logging:
level:
ROOT: INFO
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❓ Won't this be a bit confusing? I understand whatever under the logging config is going to be added to Operate's configuration file, but right now these look like variables which don't follow the same convention. Additionally, I think they can still be used as variable mistakenly? Would it make more sense to turn this into an actual string, like we do for Zeebe's log4j2.xml and the likes? Or would that be too error prone since the YAML isn't validated then?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I totally agree. I was also unsure about these properties. It seems also that they are out dated. I asked for feedback from the operate team. https://camunda.slack.com/archives/C9B5270DA/p1643803696900629

In the deployment guide it seems to reference only the log4j file, so we could do that. https://docs.camunda.io/docs/self-managed/operate-deployment/configuration/#logging

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would do that separately then

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow up issue #148

@Zelldon
Copy link
Member Author

Zelldon commented Feb 2, 2022

I assume there will be a follow up at some point to document everything in the README?

Exactly this was my plan :)

Thanks for the review!

@Zelldon Zelldon merged commit 862bbc2 into main Feb 2, 2022
@Zelldon Zelldon deleted the zell-add-operate-docs branch February 2, 2022 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants