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

Complete documentation #76

Open
vanyarock01 opened this issue Feb 9, 2021 · 1 comment
Open

Complete documentation #76

vanyarock01 opened this issue Feb 9, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@vanyarock01
Copy link
Contributor

We have a README and Tarantool Cartridge in K8s guide.
But there is no complete documentation. New content cannot always be put into a guide or README.

I offer documentation with the following structure:

  • Quick start (deploy operator and cartridge with helm)
  • Design/Architecture (TODO)
  • Tools compatibility(kubectl, minikube, kind, helm)
  • Tarantool Operator
  • Tarantool Cartridge in K8s
    • Creating an application
    • Install
    • Access Cluster (TODO)
    • Cluster management
      • Adding a new replica
      • Adding a shard (replicaset)
      • Updating application version
      • Update replicaset roles
      • Failover settings
      • Deleting a cluster
    • Customization
      • Sidecar containers
    • Troubleshooting
      • Insufficient CPU
      • Insufficient disk space
      • Recreating replicas (TODO)
    • Administration (TODO)
      • ???
    • Chart parameters table (example: https://github.com/helm/charts/tree/master/stable/postgresql#parameters) (TODO)
  • Guides
    • Contribution Guide (TODO)
    • Installation in an internal network
      • Delivery of tools
      • Installing the Tarantool Kubernetes operator
      • Installing the Tarantool Cartridge app
    • Running multiple Tarantool Cartridge clusters in different namespaces
    • Prometheus + Grafana Monitoring (TODO)
    • Crud ready-to-use application in Kubernetes
@vanyarock01 vanyarock01 added the documentation Improvements or additions to documentation label Feb 9, 2021
@kluevandrew
Copy link
Contributor

This issue is still actual, but we need to change content for new version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants