From 88e62ec5736df655cee298564de2e5da1d3ce0fe Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Fri, 7 Jul 2023 14:27:43 +0200 Subject: [PATCH] doc: improve User Data info in Launch on AWS Fixes https://github.com/scylladb/scylladb/issues/14565 This commit improves the description of ScyllaDB configuration via User Data on AWS. - The info about experimental features and developer mode is removed. - The description of User Data is fixed. - The example in User Data is updated. - The broken link is fixed. Closes #14569 --- .../install-scylla/launch-on-aws.rst | 32 ++++++++++++------- docs/operating-scylla/admin.rst | 2 ++ 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/docs/getting-started/install-scylla/launch-on-aws.rst b/docs/getting-started/install-scylla/launch-on-aws.rst index ffce5698e3..048128d9b4 100644 --- a/docs/getting-started/install-scylla/launch-on-aws.rst +++ b/docs/getting-started/install-scylla/launch-on-aws.rst @@ -22,27 +22,35 @@ Launching Instances from ScyllaDB AMI * Select your VPC. * Configure the security group. Ensure that all :ref:`ScyllaDB ports ` are open. - * **Advanced Details> User Data** – You can add the following options in the JSON format: + * **Advanced Details> User Data** – Here, you can add ScyllaDB configuration options in the JSON format. + See :ref:`scylla.yaml ` for information about supported options. + + .. TODO Replace the link to scylla.yaml to the full list of supported options - when all the options are documented. + + The following example shows a configuration using the most popular options. * ``cluster_name`` - The name of the cluster. - * ``experimental`` - If set to ``true``, it enables all experimental features. - * ``seed_provider`` - The IP of the first node. New nodes will use the IP of this seed node to connect to the cluster and learn the cluster topology and state. See `ScyllaDB Seed Nodes `_. - * ``developer_mode`` - If set to ``true``, ScyllaDB will run in :doc:`developer mode `. + * ``seed_provider`` - The IP of the first node. New nodes will use the IP of this seed node to connect to the cluster and learn the cluster topology and state. See :doc:`ScyllaDB Seed Nodes `. * ``post_configuration_script`` - A base64 encoded bash script that will be executed after the configuration is completed. - * ``start_scylla_on_first_boot`` - Start ScyllaDB once the configuration is completed. - - For full documentation of ScyllaDB AMI user data, see the `ScyllaDB Image documentation `_. + * ``start_scylla_on_first_boot`` - Starts ScyllaDB once the configuration is completed. + Example: - .. code-block:: console + .. code-block:: json { - "scylla_yaml": { - "cluster_name": "my-test-cluster", - "experimental": true - } + "scylla_yaml": { + "cluster_name": "test-cluster", + "seed_provider": [{"class_name": "org.apache.cassandra.locator.SimpleSeedProvider", + "parameters": [{"seeds": "10.0.219.209"}]}], + }, + "post_configuration_script": "#! /bin/bash\nyum install cloud-init-cfn", + "start_scylla_on_first_boot": true } + + For full documentation of ScyllaDB AMI user data, see the `ScyllaDB Image documentation `_. + #. Add storage. diff --git a/docs/operating-scylla/admin.rst b/docs/operating-scylla/admin.rst index 8ff1957961..8a56165880 100644 --- a/docs/operating-scylla/admin.rst +++ b/docs/operating-scylla/admin.rst @@ -89,6 +89,8 @@ scylla-server ------------- The :code:`scylla-server` file contains configuration related to starting up the Scylla server. +.. _admin-scylla.yaml: + .. include:: /operating-scylla/scylla-yaml.inc Compression