Skip to content

docs(parameters): release tasks + add docs on bring your own provider #1565

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

Merged
merged 5 commits into from
Jun 29, 2023

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Jun 28, 2023

Description of your changes

This PR removes all the beta notices from the Parameters utility across the repo and also introduces a new section to the Parameters documentation that shows an example of creating your own custom parameters provider.

The beta notice has been removed from the readme files and from the documentation.

I have also finally added the remaining missing section from the Parameters docs that shows how to create your own provider, for this I have chosen HashiCorp Vault (like the Python version did).

If you want to test the snippet, you can do so with the following steps:

  • Run HashiCorp Vault locally in a container (finch/docker run -e VAULT_DEV_ROOT_TOKEN_ID=abcde --cap-add=IPC_LOCK -p 8200:8200 --name=dev-vault vault)
  • Change the init configs in the customProviderVaultUsage.ts file to http://0.0.0.0:8200/v1 and abcde
  • With your browser, login into Vault using the same local url, and create a secret called my-secret under the secrets mount
  • Run the customProviderVaultUsage.ts (i.e. npx ts-node docs/snippets/parameters/customProviderVaultUsage.ts)

image

Related issues, RFCs

Issue number: #1320

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi requested a review from a team June 28, 2023 17:04
@dreamorosi dreamorosi self-assigned this Jun 28, 2023
@boring-cyborg boring-cyborg bot added automation This item relates to automation documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Jun 28, 2023
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Jun 28, 2023
@dreamorosi dreamorosi linked an issue Jun 28, 2023 that may be closed by this pull request
1 task
@dreamorosi dreamorosi requested a review from am29d June 28, 2023 17:12
@dreamorosi dreamorosi changed the title docs(parameters): release tasks + bring your own provider docs(parameters): release tasks + add docs on bring your own provider Jun 28, 2023
@boring-cyborg boring-cyborg bot added the dependencies Changes that touch dependencies, e.g. Dependabot, etc. label Jun 29, 2023
@pull-request-size pull-request-size bot added size/L PRs between 100-499 LOC and removed size/M PR between 30-99 LOC labels Jun 29, 2023
@dreamorosi dreamorosi merged commit 2c66d33 into main Jun 29, 2023
@dreamorosi dreamorosi deleted the chore/release/parameters branch June 29, 2023 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add example for create your own provider
2 participants