Uploaded image for project: 'Cassandra'
  1. Cassandra
  2. CASSANDRA-15618

add docs for production recommendations

    XMLWordPrintableJSON

    Details

    • Change Category:
      Quality Assurance
    • Complexity:
      Low Hanging Fruit
    • Platform:
      All
    • Impacts:
      None
    • Test and Documentation Plan:
      Hide

      To build the sphinx docs and preview locally:

      cd docs
      export SKIP_NODETOOL=1 # don't build the nodetool docs
      docker-compose build build-docs
      docker-compose run build-docs
      
      Show
      To build the sphinx docs and preview locally: cd docs export SKIP_NODETOOL=1 # don't build the nodetool docs docker-compose build build-docs docker-compose run build-docs

      Description

      We have some inline comments in our yaml, but I think it would be helpful if we had a more lengthy section in the docs detailing the settings people should be using in production. Some of these are unrelated to the yaml itself (like reducing read ahead), and putting them in the YAML doesn’t make much sense. There are also other settings (like compression chunk length) that don’t fit there. Let’s add a page under getting started called Production Recommendations.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                rustyrazorblade Jon Haddad
                Reporter:
                rustyrazorblade Jon Haddad
                Authors:
                Jon Haddad
                Reviewers:
                Jon Haddad, Jordan West
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m