Skip to content

Add documentation for the new config format#3661

Closed
jfim wants to merge 1 commit intomasterfrom
add-new-config-oss-docs
Closed

Add documentation for the new config format#3661
jfim wants to merge 1 commit intomasterfrom
add-new-config-oss-docs

Conversation

@jfim
Copy link
Member

@jfim jfim commented Jan 8, 2019

No description provided.

Configuration profiles
----------------------

Configuration profiles can also be used to simplify configuration management across different Pinot deployments. The Pinot
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest: "To simplify configuration management, Pinot provides a way to set up configuration profiles."

If the Pinot tools are used to deploy this table configuration with the profiles ``prod`` and ``prod-us-west-4``, this configuration
will get deployed to that particular Pinot deployment. However, the table would be skipped if the configuration profiles ``prod``
and ``prod-tokyo-1`` are passed, due to the ``prod-tokyo-1`` configuration profile not being part of the ``profiles`` section.

Copy link
Contributor

Choose a reason for hiding this comment

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

will be good to add an explicit note that all profiles in a table configuration must be included in the Pinot deployment command in order for a table configuration to be deployed.

Backing up table configurations
-------------------------------

Table configurations can be backed up using the ``BackupTableConfigs`` command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please clarify that "backing up" here means downloading configurations from the Pinot controller (to the current directory?)


For single cluster Pinot deployments, migration is done by backing up all of the table configurations as shown above.

For multiple cluster Pinot deployments, an additional merge step needs to be done to minimize the number of table files.
Copy link
Contributor

Choose a reason for hiding this comment

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

It will be useful to expand this a bit. I suppose the merge step is really not needed, but is useful (as you have pointed out, to minimize the number of files).
I would add a step between 1 and 2 that says something like "Create a folder structure depending on your deployments. For example, you can have folders configBackup/prod/prod-us-west-4, configBackup/prod/prod-us-east-3"
Expanding step 2 a bit is also useful. As in "Now change directory to each of the folders for specific deployment and enter the BackupTableConfigs command"

Some clarifications:
Is there a requirement that the 'profiles' directory be under configBackup/ some place? Can you document it either way?

profile is enabled, and unset otherwise.

There is no conflict resolution between conflicting conditional values, so a configuration containing simultaneous
different values for profile conditionals is invalid.
Copy link
Contributor

Choose a reason for hiding this comment

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

So, the result will be that the ApplyTableConfig command will throw an error? If so, please mention that.
Also, I suppose there is no implicit assumption that 'prod-us-west-4' is an extension of 'prod' profile, right? In the previous example, if somehow 'prod' and 'testing' profiles are enabled simultaneously it would result in the same error?

@npawar npawar closed this May 22, 2020
@npawar
Copy link
Contributor

npawar commented May 22, 2020

Closed this PR due to 6 months inactivity. Reopen if needed.

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.

3 participants