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 Review] Define environment variables for docker images #1312

Open
8 tasks
rsajwani opened this issue Dec 22, 2022 · 0 comments
Open
8 tasks

[Docs Review] Define environment variables for docker images #1312

rsajwani opened this issue Dec 22, 2022 · 0 comments
Assignees

Comments

@rsajwani
Copy link
Collaborator

rsajwani commented Dec 22, 2022

Parent Issue #1222
Vitess github url: https://github.com/vitessio/website

Pages to review:

We should document environment variable for each docker image we produce on dockerhub. Here are all the images.

  • vttestserver
  • k8s
  • logtail
  • logrotate
  • vtctld
  • vtctlclient
  • vtctl
  • mysqlctl
  • mysqlctld
  • vttablet
  • vtage
  • vtadmin
  • vtexplain
  • bootstrap
  • vtworker
  • lite
  • base
  • orchestrator

Lets document all images with their respective ENV variables

  • docker readme
  • vttestserver
  • perhaps create new page to list flags for each image just like above vtestserver image on website.

What to do

  • Make sure the content reflect the current state and facts are up-to-date.
  • Add details if needed either in form of new section on current page or adding new page.
  • Add links/Urls on page are working
  • Deprecate flags should be marked as 'deprecated'
  • Review is done for both V15 and V16

Please note that we are not going to focus of restructuring the website content as part of this project. It is something we will do as a separate project later on.

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

No branches or pull requests

4 participants