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
This commit is contained in:
Anna Stuchlik
2023-07-07 14:27:43 +02:00
committed by Kamil Braun
parent de7f668441
commit 88e62ec573
2 changed files with 22 additions and 12 deletions

View File

@@ -22,27 +22,35 @@ Launching Instances from ScyllaDB AMI
* Select your VPC.
* Configure the security group. Ensure that all :ref:`ScyllaDB ports <networking-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 <admin-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 </kb/seed-nodes>`_.
* ``developer_mode`` - If set to ``true``, ScyllaDB will run in :doc:`developer mode </getting-started/installation-common/dev-mod>`.
* ``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 </kb/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 <https://github.com/scylladb/scylla-machine-image>`_.
* ``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 <https://github.com/scylladb/scylla-machine-image>`_.
#. Add storage.

View File

@@ -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