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.

Sign up for GitHub

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

Jump to bottom

Go over all OPAL's config variables and add descriptions #40

Open
asafc opened this issue Apr 14, 2021 · 14 comments · May be fixed by #682
Open

Go over all OPAL's config variables and add descriptions #40

asafc opened this issue Apr 14, 2021 · 14 comments · May be fixed by #682
Labels
💎 Bounty documentation Improvements or additions to documentation hacktoberfest

Comments

@asafc
Copy link
Contributor

asafc commented Apr 14, 2021 •
edited by gemanor
Loading

Confi (our configuration lib) allows each config var to have a description string. All strings should be well explained and documented.

The acceptance criteria for this issue (updated September 2024):

  • Add a test that fails in case of missing description attribute in any of the confi variables in the following configuration files
  • Ensure the test is passing
  • Add descriptive description to any of the missing description attributes

Config files:
https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py
https://github.com/permitio/opal/blob/master/packages/opal-client/opal_client/config.py
https://github.com/permitio/opal/blob/master/packages/opal-server/opal_server/config.py
@asafc asafc added the documentation Improvements or additions to documentation label Apr 14, 2021
@asafc asafc self-assigned this Apr 14, 2021
@money8203
Copy link
Contributor

money8203 commented Jan 16, 2023 •
edited
Loading

Want me to handle the project's documentation @asafc ?

@orweis
Copy link
Contributor

orweis commented Jan 16, 2023

@money8203 for sure, we'd appreciate a hand - you can find the relevant files here:

@money8203
Copy link
Contributor

So what in specific do I have to add or document ?

@orweis
Copy link
Contributor

orweis commented Jan 17, 2023

As you can see each config value is defined via confi - e.g. calls to confi.model() or confi.bool()
Some of these are missing the "description" argument - which should contain human readable text explaining about the configuration value.

Some of these can be deduced from the variable name, some from the comments in the code, and some would require reading the code itself to explain.

@money8203
Copy link
Contributor

money8203 commented Jan 17, 2023 •
edited
Loading

#358
I've added some descriptions for this file https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py

@money8203 money8203 mentioned this issue Jan 17, 2023
Merged
roekatz added a commit that referenced this issue Jun 9, 2023
@roekatz
Merge pull request #40 from permitio/rk/fix-fetching
a49ae93 
Rk/fix fetching
@gemanor
Copy link
Collaborator

gemanor commented Sep 30, 2024

/bounty 50

@algora-pbc Algora PBC
Copy link

algora-pbc bot commented Sep 30, 2024 •
edited
Loading

💎 $50 bounty • Permit.io

Steps to solve:

  1. Start working: Comment /attempt #40 with your implementation plan
  2. Submit work: Create a pull request including /claim #40 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to permitio/opal!

Add a bounty • Share on socials

Attempt Started (GMT+0) Solution
🟢 @onyedikachi-david Oct 11, 2024, 1:00:05 PM #682
🟢 @vishwamartur Nov 17, 2024, 3:24:17 PM #702

@Bhavyajain21
Copy link

Bhavyajain21 commented Sep 30, 2024 •
edited
Loading

Is this issue still open? I see a PR merged on it @gemanor

@gemanor
Copy link
Collaborator

gemanor commented Sep 30, 2024

@Bhavyajain21 we added new acceptance criteria, see the first message in the thread

@onyedikachi-david
Copy link

onyedikachi-david commented Oct 11, 2024 •
edited by algora-pbc bot
Loading

/attempt #40

Algora profile Completed bounties Tech Active attempts Options
@onyedikachi-david 9 bounties from 4 projects
TypeScript, Python,
JavaScript & more
Cancel attempt

@onyedikachi-david onyedikachi-david linked a pull request Oct 11, 2024 that will close this issue
Open
7 tasks
@algora-pbc Algora PBC
Copy link

algora-pbc bot commented Oct 11, 2024 •
edited
Loading

💡 @onyedikachi-david submitted a pull request that claims the bounty. You can visit your bounty board to reward.

@Abiji-2020
Copy link

@gemanor can i work on this, i see a working pr already?

@vishwamartur
Copy link

vishwamartur commented Nov 17, 2024 •
edited by algora-pbc bot
Loading

/attempt #40

Options

vishwamartur added a commit to vishwamartur/opal that referenced this issue Nov 17, 2024
@vishwamartur
Add descriptions to all configuration variables
6344234 
Related to permitio#40

Add descriptions to missing configuration variables in `opal-common`, `opal-client`, and `opal-server` configuration files.

* **opal-common/config.py**:
  - Add descriptions to `LOG_FORMAT_INCLUDE_PID`, `FETCH_PROVIDER_MODULES`, `FETCHING_WORKER_COUNT`, `FETCHING_CALLBACK_TIMEOUT`, `FETCHING_ENQUEUE_TIMEOUT`, `GIT_SSH_KEY_FILE`, `AUTH_PUBLIC_KEY_FORMAT`, `AUTH_PUBLIC_KEY`, `AUTH_JWT_AUDIENCE`, `AUTH_JWT_ISSUER`, `ENABLE_METRICS`.

* **opal-client/config.py**:
  - Add descriptions to `POLICY_STORE_TYPE`, `POLICY_STORE_URL`, `POLICY_STORE_AUTH_TYPE`, `POLICY_STORE_AUTH_TOKEN`, `POLICY_STORE_AUTH_OAUTH_SERVER`, `POLICY_STORE_AUTH_OAUTH_CLIENT_ID`, `POLICY_STORE_AUTH_OAUTH_CLIENT_SECRET`, `POLICY_STORE_CONN_RETRY`, `POLICY_UPDATER_CONN_RETRY`, `DATA_STORE_CONN_RETRY`, `DATA_UPDATER_CONN_RETRY`, `POLICY_STORE_POLICY_PATHS_TO_IGNORE`, `POLICY_STORE_TLS_CLIENT_CERT`, `POLICY_STORE_TLS_CLIENT_KEY`, `POLICY_STORE_TLS_CA`, `EXCLUDE_POLICY_STORE_SECRETS`, `INLINE_OPA_ENABLED`, `INLINE_OPA_CONFIG`, `INLINE_OPA_LOG_FORMAT`, `INLINE_CEDAR_ENABLED`, `INLINE_CEDAR_CONFIG`, `INLINE_CEDAR_LOG_FORMAT`, `KEEP_ALIVE_INTERVAL`, `SERVER_URL`, `SERVER_WS_URL`, `SERVER_PUBSUB_URL`, `CLIENT_TOKEN`, `POLICY_SUBSCRIPTION_DIRS`, `DATA_UPDATER_ENABLED`, `DEFAULT_UPDATE_CALLBACK`, `DEFAULT_UPDATE_CALLBACKS`, `SCOPE_ID`.

* **opal-server/config.py**:
  - Add descriptions to `WS_LOCAL_URL`, `WS_TOKEN`, `BROADCAST_URI`, `BROADCAST_CHANNEL_NAME`, `BROADCAST_CONN_LOSS_BUGFIX_EXPERIMENT_ENABLED`, `AUTH_PRIVATE_KEY_FORMAT`, `AUTH_PRIVATE_KEY_PASSPHRASE`, `AUTH_PRIVATE_KEY`, `AUTH_JWKS_URL`, `AUTH_JWKS_STATIC_DIR`, `AUTH_MASTER_TOKEN`, `POLICY_SOURCE_TYPE`, `POLICY_REPO_REUSE_CLONE_PATH`, `POLICY_REPO_MAIN_BRANCH`, `POLICY_REPO_SSH_KEY`, `POLICY_REPO_MANIFEST_PATH`, `POLICY_REPO_CLONE_TIMEOUT`, `LEADER_LOCK_FILE_PATH`, `POLICY_BUNDLE_SERVER_TYPE`, `REPO_WATCHER_ENABLED`, `PUBLISHER_ENABLED`, `BROADCAST_KEEPALIVE_INTERVAL`, `ALL_DATA_TOPIC`, `ALL_DATA_ROUTE`, `ALL_DATA_URL`, `POLICY_REPO_WEBHOOK_SECRET`, `POLICY_REPO_WEBHOOK_ENFORCE_BRANCH`, `POLICY_REPO_WEBHOOK_PARAMS`, `POLICY_REPO_POLLING_INTERVAL`, `ALLOWED_ORIGINS`, `FILTER_FILE_EXTENSIONS`, `BUNDLE_IGNORE`, `NO_RPC_LOGS`, `SERVER_WORKER_COUNT`, `ENABLE_DATADOG_APM`, `SCOPES`, `SCOPES_REPO_CLONES_SHARDS`, `REDIS_URL`, `BASE_DIR`.

* Add a test in `opal-common/tests/test_config.py` to check for missing descriptions in configuration variables.
@vishwamartur vishwamartur mentioned this issue Nov 17, 2024
Open
@algora-pbc Algora PBC
Copy link

algora-pbc bot commented Nov 17, 2024

💡 @vishwamartur submitted a pull request that claims the bounty. You can visit your bounty board to reward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
💎 Bounty documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(config): add descriptions to all configuration variables and tests onyedikachi-david/opal
8 participants
@orweis @asafc @gemanor @onyedikachi-david @vishwamartur @Bhavyajain21 @money8203 @Abiji-2020