docs: add config example with migration guide #375
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 11348922333Details
💛 - Coveralls |
gusinacio
force-pushed
the
gusinacio/migration-config
branch
from
954004e to
5d8bad9
Compare
Signed-off-by: Gustavo Inacio <[email protected]>
gusinacio
force-pushed
the
gusinacio/migration-config
branch
from
5d8bad9 to
037cb41
Compare
carlosvdr
approved these changes
Oct 15, 2024
Comment on lines
+3
to
+7
| In case you want to quickly migrate from the old stack into the new stack, you can use the following two configurations to help you to migrate without changing too much fields. | ||
|
|
||
| You just need to drop the config, use it in the `--config` args and add some additional environment variables. | ||
|
|
||
| Please take a deeper look in the config, but 90% of the time you'll be safe just using it. If you find any issues using this config, feel free to open an issue. |
There was a problem hiding this comment.
If you check a Markdown guide they say .md is supposed be formatted so that if you used cat in a terminal and thus limited to 80 chars per line. Up to you.
| @@ -0,0 +1,34 @@ | |||
| # Migration guide | |||
|
|
|||
| In case you want to quickly migrate from the old stack into the new stack, you can use the following two configurations to help you to migrate without changing too much fields. | |||
There was a problem hiding this comment.
Suggested change
| In case you want to quickly migrate from the old stack into the new stack, you can use the following two configurations to help you to migrate without changing too much fields. | |
| If you want to migrate quickly from the old stack to the new stack, you can use the following two configurations to help you to do so without changing too many fields. |
| INDEXER_SUBGRAPHS__ESCROW__DEPLOYMENT_ID=<escrow deployment id> | ||
| ``` | ||
|
|
||
| We recommend you migrating overtime to be fully in the configuration and don't need to provide multiple environment variables that can stay in plaintext, this will make your work easier. |
There was a problem hiding this comment.
Suggested change
| We recommend you migrating overtime to be fully in the configuration and don't need to provide multiple environment variables that can stay in plaintext, this will make your work easier. | |
| We recommend gradually transitioning to a full configuration setup, so you won’t need to rely on multiple environment variables, especially those stored in plaintext. This will simplify your workflow and improve security. |
|
|
||
| The configuration doesn't accept booleans as strings, so in case you had `INDEXER_SERVICE_SERVE_NETWORK_SUBGRAPH` environment variable, please update to `INDEXER_SERVICE__SERVE_NETWORK_SUBGRAPH` and use `true/false` as values (or you could update directly in the configuration). | ||
|
|
||
| Please update the config accordingly. Also, check it out the explanation for each field in [config/minimal-config-example.toml](config/minimal-config-example.toml) and also [config/maximal-config-example.toml](config/maximal-config-example.toml) |
There was a problem hiding this comment.
Suggested change
| Please update the config accordingly. Also, check it out the explanation for each field in [config/minimal-config-example.toml](config/minimal-config-example.toml) and also [config/maximal-config-example.toml](config/maximal-config-example.toml) | |
| Please update the config accordingly. Also, check out the explanation for each field in [config/minimal-config-example.toml](config/minimal-config-example.toml) and also [config/maximal-config-example.toml](config/maximal-config-example.toml). |
| free_query_auth_token = "${INDEXER_SERVICE_FREE_QUERY_AUTH_TOKEN}" | ||
|
|
||
| ######################################## | ||
| # Specific configurations to tap-agent # |
There was a problem hiding this comment.
Suggested change
| # Specific configurations to tap-agent # | |
| # tap-agent configurations # |
There was a problem hiding this comment.
This was taken from our default values.
There was a problem hiding this comment.
Suggested change
| # Specific configurations to tap-agent # | |
| # Specific configurations for tap-agent # |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.