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

[docs-only] [chore] Update helper generated envvar yamls #9383

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Jun 14, 2024

The extended_vars.yaml and env_vars.yaml need regular update on envvar changes. This PR takes care on. Admin docs only relevant.

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Contributor

@phil-davis phil-davis left a comment

Choose a reason for hiding this comment

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

It is a bit difficult to know if all this stuff is correct. There are quite a few changes for introductionVersion between pre5.0 and 5.0 for example. Maybe those are all correct fixes for previous errors.

I am approving so that this can be merged, since any adjustments need to be done back in the sources anyway.

type: int
description: The maximum quantity of items in the store. Only applies when store
type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package
though not exclicitely set as default.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
though not exclicitely set as default.
though not explicitly set as default.

I know that this text is being imported from elsewhere - so I suppose that I need to make a PR to the source, and then another PR can be done to fix the little stuff.

@@ -1,3 +1,104 @@
ACTIVITYLOG_SERVICE_ACCOUNT_ID:
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are there various new env vars with introductionVersion: "5.0" ?
5.0 was released a while ago, so I expected that these would already exist in the docs.

description: 'The type of the store. Supported values are: ''memory'', ''ocmem'',
''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description
for details.'
introductionVersion: pre5.0
Copy link
Contributor

Choose a reason for hiding this comment

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

This one is "pre5.0" - that seems weird - if the env var existed before 5.0, then why is it not already in the docs?

Comment on lines -7208 to +7562
description: The bind address of the gateway GRPC address.
introductionVersion: "5.0"
description: The bind address of the GRPC service.
introductionVersion: pre5.0
Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose that the introductionVersion was wrong previously, and someone reset it to "pre5.0"

@mmattel mmattel merged commit 74b006a into master Jun 14, 2024
2 checks passed
@phil-davis
Copy link
Contributor

Hmmm - looks like it auto-merged when I clicked approve! I hope that it doesn't "break the internet".

@mmattel mmattel deleted the update_extended_envvars.yaml branch June 14, 2024 08:18
ownclouders pushed a commit that referenced this pull request Jun 14, 2024
[docs-only] [chore] Update helper generated envvar yamls
@mmattel
Copy link
Contributor Author

mmattel commented Jun 14, 2024

Hmmm - looks like it auto-merged when I clicked approve! I hope that it doesn't "break the internet".

No it does not 🤣

I will file a new PR to correct the typo.

Regarding 5.0 or pre5.0, this is all correct even it seems not to be so. The helper process gathers all stuff from the ocis code. Sometimes this can be a bit confusing like with
OCIS_SERVICE_ACCOUNT_ID; ACTIVITYLOG_SERVICE_ACCOUNT_ID. The OCIS_ envvar was introduced in 5.0, the ACTIVITYLOG_ envvar is the local variant of the global one introduced last week. By design, it is therefore not a new envvar (...) as the global one existed before. Local overwrites global if set, else global is taken.

Hope this makes it more clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants