From 9e007ac2ad06df715dc93275630da824154963e3 Mon Sep 17 00:00:00 2001 From: Zain Malik Date: Mon, 4 May 2020 18:28:05 +0200 Subject: [PATCH] format parameters.md --- docs/parameters.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/parameters.md b/docs/parameters.md index 7bd3dca8..b3482f4f 100644 --- a/docs/parameters.md +++ b/docs/parameters.md @@ -1,7 +1,6 @@ # Parameters - -| Name | Description | Default | -| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Description | Default | +|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **NODE_COUNT** | Number of Cassandra nodes. | 3 | | **NODE_CPU_MC** | CPU request (in millicores) for the Cassandra node containers. | 1000 | | **NODE_CPU_LIMIT_MC** | CPU limit (in millicores) for the Cassandra node containers. | 1000 | @@ -32,7 +31,7 @@ | **BACKUP_TRIGGER** | Trigger parameter to start a backup. Simply needs to be changed from the current value to start a backup | 1 | | **BACKUP_AWS_CREDENTIALS_SECRET** | If set, can be used to provide the access_key, secret_key and security_token with a secret | | | **BACKUP_AWS_S3_BUCKET_NAME** | The name of the AWS S3 bucket to store the backups | | -| **BACKUP_AWS_S3_STORAGE_PROVIDER** | Should be one of the s3\_\* values from https://github.com/apache/libcloud/blob/trunk/libcloud/storage/types.py | s3_us_west_oregon | +| **BACKUP_AWS_S3_STORAGE_PROVIDER** | Should be one of the s3_* values from https://github.com/apache/libcloud/blob/trunk/libcloud/storage/types.py | s3_us_west_oregon | | **BACKUP_PREFIX** | A prefix to be used inside the S3 bucket | | | **BACKUP_MEDUSA_CPU_MC** | CPU request (in millicores) for the Medusa backup containers. | 100 | | **BACKUP_MEDUSA_CPU_LIMIT_MC** | CPU limit (in millicores) for the Medusa backup containers. | 500 | @@ -44,6 +43,7 @@ | **RESTORE_FLAG** | If true, a restore is done on installation | False | | **RESTORE_OLD_NAMESPACE** | The namespace from the operator that was used to create the backup | | | **RESTORE_OLD_NAME** | The instance name from the operator that was used to create the backup | | +| **BOOTSTRAP_TIMEOUT** | Timeout for the bootstrap binary to join the cluster with the new IP. Valid time units are 'ns', 'us', 'ms', 's', 'm', 'h'. | 12h30m | | **NODE_TOPOLOGY** | This describes a multi-datacenter setup. When set it has precedence over NODE_COUNT. See docs/multidatacenter.md for more details. | | | **NODE_ANTI_AFFINITY** | Ensure that every Cassandra node is deployed on separate hosts | False | | **NODE_RESOLVE_SERVICEACCOUNT** | A service account that can list nodes in the cluster to read rack names for deployed pods | node-resolver | @@ -86,7 +86,7 @@ | **ROLE_MANAGER** | Part of the Authentication & Authorization backend that implements IRoleManager to maintain grants and memberships between roles, By default, the value set is Apache Cassandra's out of the box Role Manager: CassandraRoleManager | CassandraRoleManager | | **ROLES_VALIDITY_IN_MS** | Validity period for roles cache; set to 0 to disable | 2000 | | **ROLES_UPDATE_INTERVAL_IN_MS** | After this interval, cache entries become eligible for refresh. Upon next access, Cassandra schedules an async reload, and returns the old value until the reload completes. If roles_validity_in_ms is non-zero, then this must be also. | | -| **CREDENTIALS_VALIDITY_IN_MS** | This cache is tightly coupled to the provided PasswordAuthenticator implementation of IAuthenticator. If another IAuthenticator implementation is configured, Cassandra does not use this cache, and these settings have no effect. Set to 0 to disable. | 2000 | +| **CREDENTIALS_VALIDITY_IN_MS** | This cache is tightly coupled to the provided PasswordAuthenticator implementation of IAuthenticator. If another IAuthenticator implementation is configured, Cassandra does not use this cache, and these settings have no effect. Set to 0 to disable. | 2000 | | **CREDENTIALS_UPDATE_INTERVAL_IN_MS** | After this interval, cache entries become eligible for refresh. The next time the cache is accessed, the system schedules an asynchronous reload of the cache. Until this cache reload is complete, the cache returns the old values. If credentials_validity_in_ms is nonzero, this property must also be nonzero. | | | **PERMISSIONS_VALIDITY_IN_MS** | How many milliseconds permissions in cache remain valid. Fetching permissions can be resource intensive. To disable the cache, set this to 0. | 2000 | | **PERMISSIONS_UPDATE_INTERVAL_IN_MS** | If enabled, sets refresh interval for the permissions cache. After this interval, cache entries become eligible for refresh. On next access, Cassandra schedules an async reload and returns the old value until the reload completes. If permissions_validity_in_ms is nonzero, permissions_update_interval_in_ms must also be non-zero. | | @@ -178,7 +178,7 @@ | **RPC_SERVER_TYPE** | Cassandra provides three options for the RPC server. sync and hsha performance is about the same, but hsha uses less memory. | sync | | **ENDPOINT_SNITCH** | Set to a class that implements the IEndpointSnitch interface. Cassandra uses the snitch to locate nodes and route requests. | SimpleSnitch | | **DISK_FAILURE_POLICY** | The policy for how Cassandra responds to disk failure | stop | -| **ENABLE_USER_DEFINED_FUNCTIONS** | User defined functions (UDFs) present a security risk, since they are executed on the server side. UDFs are executed in a sandbox to contain the execution of malicious code. | False | +| **ENABLE_USER_DEFINED_FUNCTIONS** | User defined functions (UDFs) present a security risk, since they are executed on the server side. UDFs are executed in a sandbox to contain the execution of malicious code. | False | | **ENABLE_SCRIPTED_USER_DEFINED_FUNCTIONS** | Java UDFs are always enabled, if enable_user_defined_functions is true. Enable this option to use UDFs with language javascript or any custom JSR-223 provider. This option has no effect if enable_user_defined_functions is false | False | | **ENABLE_MATERIALIZED_VIEWS** | Enables materialized view creation on this node. Materialized views are considered experimental and are not recommended for production use. | False | | **CDC_ENABLED** | Enable / disable CDC functionality on a per-node basis. This modifies the logic used for write path allocation rejection | False | @@ -195,10 +195,10 @@ | **BACK_PRESSURE_STRATEGY_FLOW** | The flow speed to apply rate limiting: FAST - rate limited to the speed of the fastest replica. SLOW - rate limit to the speed of the slowest replica. | FAST | | **ALLOCATE_TOKENS_FOR_KEYSPACE** | Triggers automatic allocation of num_tokens tokens for this node. The allocation algorithm attempts to choose tokens in a way that optimizes replicated load over the nodes in the datacenter for the replication strategy used by the specified keyspace. | | | **HINTS_DIRECTORY** | Directory where Cassandra should store hints. | | -| **COMMITLOG_DIRECTORY** | When running on magnetic HDD, this should be a separate spindle than the data directories. If not set, the default directory is \$CASSANDRA_HOME/data/commitlog. | | +| **COMMITLOG_DIRECTORY** | When running on magnetic HDD, this should be a separate spindle than the data directories. If not set, the default directory is $CASSANDRA_HOME/data/commitlog. | | | **CDC_RAW_DIRECTORY** | CommitLogSegments are moved to this directory on flush if cdc_enabled: true and the segment contains mutations for a CDC-enabled table | | | **ROW_CACHE_CLASS_NAME** | Row cache implementation class name. | | -| **SAVED_CACHES_DIRECTORY** | saved caches If not set, the default directory is \$CASSANDRA_HOME/data/saved_caches. | | +| **SAVED_CACHES_DIRECTORY** | saved caches If not set, the default directory is $CASSANDRA_HOME/data/saved_caches. | | | **INTERNODE_SEND_BUFF_SIZE_IN_BYTES** | Set socket buffer size for internode communication Note that when setting this, the buffer size is limited by net.core.wmem_max and when not setting it it is defined by net.ipv4.tcp_wm | | | **INTERNODE_RECV_BUFF_SIZE_IN_BYTES** | Set socket buffer size for internode communication Note that when setting this, the buffer size is limited by net.core.wmem_max and when not setting it it is defined by net.ipv4.tcp_wmem | | | **GC_LOG_THRESHOLD_IN_MS** | GC Pauses greater than 200 ms will be logged at INFO level This threshold can be adjusted to minimize logging if necessary | |