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

Refactor docs related to Scylla Manager integration #1898

Open
rzetelskik opened this issue Apr 16, 2024 · 0 comments
Open

Refactor docs related to Scylla Manager integration #1898

rzetelskik opened this issue Apr 16, 2024 · 0 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@rzetelskik
Copy link
Member

rzetelskik commented Apr 16, 2024

What should the feature do?

We should refactor the pages of our docs related to Scylla Manager integration.

/kind documentation

What is the use case behind this feature?

Currently, the pages of our docs related to Scylla Manager are all over the place. There is an aggregated page Deploying Scylla Manager on a Kubernetes Cluster covering the deployment and task scheduling. Then, in an entirely different place, there's Restore from backup covering the manual procedure for backup restore.

I propose we refactor this part of our docs by creating a separate subtree dedicated to Scylla Manager integration, covering the following in separate pages:

  • current architecture of Scylla Manager in k8s clusters
  • deploying Scylla Manager in k8s clusters
  • scheduling backups
  • scheduling repairs
  • manual restore from backup procedure

Possibly also additional documents (or integrated into the above) for manager integration with multi-datacenter ScyllaDB clusters.

Alternatively, we can wait with this until we implement proper isolation and managed deployments.

Anything else we need to know?

The purpose of this issue is first and foremost to serve as a place for suggestions and discussion related to Scylla Manager integration docs.

@rzetelskik rzetelskik added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 16, 2024
@scylla-operator-bot scylla-operator-bot bot added kind/documentation Categorizes issue or PR as related to documentation. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Apr 16, 2024
@tnozicka tnozicka added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed kind/feature Categorizes issue or PR as related to a new feature. labels Apr 17, 2024
@scylla-operator-bot scylla-operator-bot bot removed the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

No branches or pull requests

2 participants