diff --git a/docs/reference/config.md b/docs/reference/config.md index 3442afa9ec488c32d6126c853785ccd1fe39d271..24144b74f7b8591929cafbe515cf97d7a43e70ab 100644 --- a/docs/reference/config.md +++ b/docs/reference/config.md @@ -39,75 +39,75 @@ picodata run --config <PATH> ``` yaml title="config.yaml" cluster: - cluster_id: demo # (4)! + cluster_id: demo # (1)! tier: default: - replication_factor: 1 # (20)! - can_vote: true # (21)! - default_replication_factor: 1 # (8)! + replication_factor: 1 # (4)! + can_vote: true # (3)! + default_replication_factor: 1 # (2)! instance: - data_dir: . # (5)! - service_password_file: null # (16)! - instance_id: null # (9)! - replicaset_id: null # (15)! - tier: default # (18)! - failure_domain: {} # (6)! - peer: # (13)! + data_dir: . # (8)! + service_password_file: null # (25)! + instance_id: null # (11)! + replicaset_id: null # (24)! + tier: default # (27)! + failure_domain: {} # (9)! + peer: # (20)! - localhost:3301 - listen: localhost:3301 # (10)! - advertise_address: localhost:3301 # (2)! - http_listen: null # (7)! - admin_socket: ./admin.sock # (1)! - plugin_dir: null # (14)! - audit: null # (3)! - shredding: false # (17)! + listen: localhost:3301 # (13)! + advertise_address: localhost:3301 # (6)! + http_listen: null # (10)! + admin_socket: ./admin.sock # (5)! + plugin_dir: null # (23)! + audit: null # (7)! + shredding: false # (26)! log: - level: info # (12)! - destination: null # (11)! - format: plain # (22)! + level: info # (16)! + destination: null # (14)! + format: plain # (15)! memtx: - memory: 67108864 # (23)! - checkpoint_count: 2 # (24)! - checkpoint_interval: 3600.0 # (25)! + memory: 67108864 # (19)! + checkpoint_count: 2 # (17)! + checkpoint_interval: 3600.0 # (18)! vinyl: - memory: 134217728 # (26)! - cache: 134217728 # (27)! + memory: 134217728 # (29)! + cache: 134217728 # (28)! iproto: - max_concurrent_messages: 768 # (28)! + max_concurrent_messages: 768 # (12)! pg: - listen: null # (19)! - ssl: false # (29)! + listen: null # (21)! + ssl: false # (22)! ``` -1. [🔗 picodata run --admin-sock](cli.md#run_admin_sock) -2. [🔗 picodata run --advertise](cli.md#run_advertise) -3. [🔗 picodata run --audit](cli.md#run_audit) -4. [🔗 picodata run --cluster-id](cli.md#run_cluster_id) -5. [🔗 picodata run --data-dir](cli.md#run_data_dir) -6. [🔗 picodata run --failure-domain](cli.md#run_failure_domain) -7. [🔗 picodata run --http-listen](cli.md#run_http_listen) -8. [🔗 picodata run --init-replication-factor](cli.md#run_init_replication_factor) -9. [🔗 picodata run --instance-id](cli.md#run_instance_id) -10. [🔗 picodata run --listen](cli.md#run_listen) -11. [🔗 picodata run --log](cli.md#run_log) -12. [🔗 picodata run --log-level](cli.md#run_log_level) -13. [🔗 picodata run --peer](cli.md#run_peer) -14. [🔗 picodata run --plugin-dir](cli.md#run_plugin_dir) -15. [🔗 picodata run --replicaset-id](cli.md#run_replicaset_id) -16. [🔗 picodata run --service-password-file](cli.md#run_service_password_file) -17. [🔗 picodata run --shredding](cli.md#run_shredding) -18. [🔗 picodata run --tier](cli.md#run_tier) -19. [🔗 picodata run --pg-listen](cli.md#run_pg_listen) -20. [cluster.tier.<tier_name\>.replication_factor](#cluster_tier_tier_replication_factor) -21. [cluster.tier.<tier_name\>.can_vote](#cluster_tier_tier_can_vote) -22. [instance.log.format](#instance_log_format) -23. [instance.memtx.memory](#instance_memtx_memory) -24. [instance.memtx.checkpoint_count](#instance_memtx_checkpoint_count) -25. [instance.memtx.checkpoint_interval](#instance_memtx_checkpoint_interval) -26. [instance.vinyl.memory](#instance_vinyl_memory) -27. [instance.vinyl.cache](#instance_vinyl_cache) -28. [instance.iproto.max_concurrent_messages](#instance_iproto_max_concurrent_messages) -29. [instance.pg.ssl](#instance_pg_ssl) +1. [cluster.cluster_id](#cluster_cluster_id) +2. [cluster.default_replication_factor](#cluster_default_replication_factor) +3. [cluster.tier.<tier_name\>.can_vote](#cluster_tier_tier_can_vote) +4. [cluster.tier.<tier_name\>.replication_factor](#cluster_tier_tier_replication_factor) +5. [instance.admin_socket](#instance_admin_socket) +6. [instance.advertise_address](#instance_advertise_address) +7. [instance.audit](#instance_audit) +8. [instance.data_dir](#instance_data_dir) +9. [instance.failure_domain](#instance_failure_domain) +10. [instance.http_listen](#instance_http_listen) +11. [instance.instance_id](#instance_instance_id) +12. [instance.iproto.max_concurrent_messages](#instance_iproto_max_concurrent_messages) +13. [instance.listen](#instance_listen) +14. [instance.log.destination](#instance_log_destination) +15. [instance.log.format](#instance_log_format) +16. [instance.log.level](#instance_log_level) +17. [instance.memtx.checkpoint_count](#instance_memtx_checkpoint_count) +18. [instance.memtx.checkpoint_interval](#instance_memtx_checkpoint_interval) +19. [instance.memtx.memory](#instance_memtx_memory) +20. [instance.peer](#instance_peer) +21. [instance.pg.listen](#instance_pg_listen) +22. [instance.pg.ssl](#instance_pg_ssl) +23. [instance.plugin_dir](#instance_plugin_dir) +24. [instance.replicaset_id](#instance_replicaset_id) +25. [instance.service_password_file](#instance_service_password_file) +26. [instance.shredding](#instance_shredding) +27. [instance.tier](#instance_tier) +28. [instance.vinyl.cache](#instance_vinyl_cache) +29. [instance.vinyl.memory](#instance_vinyl_memory) См. также: @@ -115,6 +115,33 @@ instance: ## Параметры файла конфигурации {: #config_file_parameters } +### cluster.cluster_id {: #cluster_cluster_id } + +Ð˜Ð¼Ñ ÐºÐ»Ð°Ñтера. ИнÑÑ‚Ð°Ð½Ñ Ð½Ðµ Ñможет приÑоединитьÑÑ Ðº клаÑтеру Ñ Ð´Ñ€ÑƒÐ³Ð¸Ð¼ именем. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `demo` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_CLUSTER_ID`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --cluster-id](cli.md#run_cluster_id) + +### cluster.default_replication_factor {: #cluster_default_replication_factor } + +ЧиÑло реплик — инÑтанÑов Ñ Ð¾Ð´Ð¸Ð½Ð°ÐºÐ¾Ð²Ñ‹Ð¼ набором хранимых данных — Ð´Ð»Ñ ÐºÐ°Ð¶Ð´Ð¾Ð³Ð¾ +репликаÑета. + +Данные: + +* Тип: *int* +* Значение по умолчанию: `1` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_INIT_REPLICATION_FACTOR`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --init-replication-factor](cli.md#run_init_replication_factor) + ### cluster.tier.<tier_name\>.can_vote {: #cluster_tier_tier_can_vote } Признак тира *<tier_name\>*, определÑющий возможноÑÑ‚ÑŒ инÑтанÑов учаÑтвовать @@ -125,6 +152,13 @@ instance: * Тип: *bool* * Значение по умолчанию: `true` +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c cluster.tier='{"default": {"replication_factor": 1, "can_vote": false}}' +``` + См. также: * [ДинамичеÑкое переключение голоÑующих узлов в Raft](../architecture/raft_failover.md#raft_voter_failover) @@ -138,6 +172,122 @@ instance: * Тип: *int* * Значение по умолчанию: `1` +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c cluster.tier='{"default": {"replication_factor": 3, "can_vote": true}}' +``` + +### instance.admin_socket {: #instance_admin_socket } + +Путь к unix-Ñокету Ð´Ð»Ñ Ð¿Ð¾Ð´ÐºÐ»ÑŽÑ‡ÐµÐ½Ð¸Ñ Ðº конÑоли админиÑтратора Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ +команды `picodata admin`. Ð’ отличие от `picodata connect`, ÐºÐ¾Ð¼Ð¼ÑƒÐ½Ð¸ÐºÐ°Ñ†Ð¸Ñ +оÑущеÑтвлÑетÑÑ Ð² виде обычного текÑта и вÑегда проиÑходит под учетной +запиÑью админиÑтратора. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `./admin.sock` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_ADMIN_SOCK`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --admin-sock](cli.md#run_admin_sock) + +### instance.advertise_address {: #instance_advertise_address } + +Публичный Ñетевой Ð°Ð´Ñ€ÐµÑ Ð¸Ð½ÑтанÑа. ÐнонÑируетÑÑ ÐºÐ»Ð°Ñтеру при запуÑке +инÑтанÑа и иÑпользуетÑÑ Ð´Ð»Ñ Ð¿Ð¾Ð´ÐºÐ»ÑŽÑ‡ÐµÐ½Ð¸Ñ Ðº нему других инÑтанÑов. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `localhost:3301` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_ADVERTISE`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --advertise](cli.md#run_advertise) + +### instance.audit {: #instance_audit } + +ÐšÐ¾Ð½Ñ„Ð¸Ð³ÑƒÑ€Ð°Ñ†Ð¸Ñ Ð¶ÑƒÑ€Ð½Ð°Ð»Ð° аудита. ДоÑтупны Ñледующие варианты: + +* `file:<FILE>` или проÑто `<FILE>` — запиÑÑŒ в файл +* `pipe:<COMMAND>` или `| <COMMAND>` — перенаправление вывода в подпроцеÑÑ +* `syslog:` — перенаправление вывода в Ñлужбу `syslog` защищенной ОС + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_AUDIT_LOG`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --audit](cli.md#run_audit) + +### instance.data_dir {: #instance_data_dir } + +Ð Ð°Ð±Ð¾Ñ‡Ð°Ñ Ð´Ð¸Ñ€ÐµÐºÑ‚Ð¾Ñ€Ð¸Ñ Ð¸Ð½ÑтанÑа. ЗдеÑÑŒ Picodata хранит вÑе данные. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `.` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_DATA_DIR`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --data-dir](cli.md#run_data_dir) + +### instance.failure_domain {: #instance_failure_domain } + +СпиÑок пар ключ-значение, разделенных запÑтыми, определÑющий географичеÑкое +раÑположение Ñервера — [зоны доÑтупноÑти]. Picodata не будет объединÑÑ‚ÑŒ +два инÑтанÑа в один репликаÑет, еÑли у них Ñовпадают Ð·Ð½Ð°Ñ‡ÐµÐ½Ð¸Ñ Ñ…Ð¾Ñ‚Ñ Ð±Ñ‹ в +одном ключе. ВмеÑто Ñтого будет Ñоздан новый репликаÑет. РепликаÑеты +формируютÑÑ Ð¸Ð· инÑтанÑов Ñ Ñ€Ð°Ð·Ð½Ñ‹Ð¼Ð¸ зонами доÑтупноÑти до тех пор, пока не +будет доÑтигнут желаемый [фактор репликации]. + +[зоны доÑтупноÑти]: ../tutorial/deploy.md#failure_domains +[фактор репликации]: ../overview/glossary.md#replication_factor + +Данные: + +<!-- https://yaml.org/spec/1.2.2/#822-block-mappings --> +* Тип: Block Mappings of *{ str: str }* +* Значение по умолчанию: `{}` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_FAILURE_DOMAIN`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --failure-domain](cli.md#run_failure_domain) + +### instance.http_listen {: #instance_http_listen } + +ÐÐ´Ñ€ÐµÑ HTTP-Ñервера. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_HTTP_LISTEN`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --http-listen](cli.md#run_http_listen) + +### instance.instance_id {: #instance_instance_id } + +Ð˜Ð¼Ñ Ð¸Ð½ÑтанÑа. При отÑутÑтвии параметра значение будет автоматичеÑки +Ñгенерировано raft-лидером в момент приÑÐ¾ÐµÐ´Ð¸Ð½ÐµÐ½Ð¸Ñ Ð¸Ð½ÑтанÑа к клаÑтеру. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_INSTANCE_ID`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --instance-id](cli.md#run_instance_id) + ### instance.iproto.max_concurrent_messages {: #instance_iproto_max_concurrent_messages } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-networking-net-msg-max --> @@ -173,6 +323,45 @@ not be processed until some time after delivery. --> * Тип: *int* * Значение по умолчанию: `768` +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.iproto.max_concurrent_messages=1536 +``` + +### instance.listen {: #instance_listen } + +Сетевой Ð°Ð´Ñ€ÐµÑ Ð¸Ð½ÑтанÑа. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `localhost:3301` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_LISTEN`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --listen](cli.md#run_listen) + +### instance.log.destination {: #instance_log_destination } + +ÐšÐ¾Ð½Ñ„Ð¸Ð³ÑƒÑ€Ð°Ñ†Ð¸Ñ Ð¾Ñ‚Ð»Ð°Ð´Ð¾Ñ‡Ð½Ð¾Ð³Ð¾ журнала. ДоÑтупны Ñледующие варианты: + +* `file:<FILE>` или проÑто `<FILE>` — запиÑÑŒ в файл +* `pipe:<COMMAND>` или `| <COMMAND>` — перенаправление вывода в подпроцеÑÑ +* `syslog:` — перенаправление вывода в Ñлужбу `syslog` защищенной ОС + +По умолчанию отладочный журнал выводитÑÑ Ð² *stderr*. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_LOG`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --log](cli.md#run_log) + ### instance.log.format {: #instance_log_format } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-logging-log-format --> @@ -185,6 +374,30 @@ not be processed until some time after delivery. --> * Тип: *str* * Значение по умолчанию: `plain` +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_LOG`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.log.format=json +``` + +### instance.log.level {: #instance_log_level } + +Уровень важноÑти Ñобытий, региÑтрируемых в отладочном журнале. + +Возможные значениÑ: `fatal`, `system`, `error`, `crit`, `warn`, `info`, +`verbose`, `debug` + +Данные: + +* Тип: *str* +* Значение по умолчанию: `info` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_LOG_LEVEL`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --log-level](cli.md#run_log_level) + ### instance.memtx.checkpoint_count {: #instance_memtx_checkpoint_count } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-checkpoint-daemon-checkpoint-count --> @@ -198,6 +411,13 @@ not be processed until some time after delivery. --> * Тип: *int* * Значение по умолчанию: `2` +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.memtx.checkpoint_count=5 +``` + ### instance.memtx.checkpoint_interval {: #instance_memtx_checkpoint_interval } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-checkpoint-daemon-checkpoint-interval --> @@ -212,6 +432,13 @@ not be processed until some time after delivery. --> * Тип: *float* * Значение по умолчанию: `3600.0` (1 чаÑ) +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.memtx.checkpoint_interval=7200.0 +``` + ### instance.memtx.memory {: #instance_memtx_memory } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-memtx-memory --> @@ -228,9 +455,37 @@ not be processed until some time after delivery. --> * Тип: *int* * Значение по умолчанию: `67108864` (64 МБ) -См. также: +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_MEMTX_MEMORY`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --memtx-memory](cli.md#run_memtx_memory) + +### instance.peer {: #instance_peer } + +СпиÑок Ñетевых адреÑов других инÑтанÑов. ИÑпользуетÑÑ Ð¿Ñ€Ð¸ инициализации +клаÑтера и приÑоединении инÑтанÑа к уже ÑущеÑтвующему клаÑтеру. + +Данные: + +<!-- https://yaml.org/spec/1.2.2/#821-block-sequences --> +* Тип: Block Sequence of *str* +* Значение по умолчанию: `- localhost:3301` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_PEER`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --peer](cli.md#run_peer) + +### instance.pg.listen {: #instance_pg_listen } -* [picodata run --memtx-memory](cli.md#run_memtx_memory) +ÐÐ´Ñ€ÐµÑ Ñервера [Pgproto](../tutorial/connecting.md#pgproto). + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_PG_LISTEN`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --pg-listen](cli.md#run_pg_listen) ### instance.pg.ssl {: #instance_pg_ssl } @@ -248,6 +503,86 @@ SSL-Ñертификаты: * Тип: *bool* * Значение по умолчанию: `false` +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.pg.ssl=true +``` + +### instance.plugin_dir {: #instance_plugin_dir } + +Путь к директории, Ñодержащей файлы плагинов. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_PLUGIN_DIR`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --plugin-dir](cli.md#run_plugin_dir) + +### instance.replicaset_id {: #instance_replicaset_id } + +Ð˜Ð¼Ñ Ñ€ÐµÐ¿Ð»Ð¸ÐºÐ°Ñета. ИÑпользуетÑÑ Ð¿Ñ€Ð¸ инициализации клаÑтера и приÑоединении +инÑтанÑа к уже ÑущеÑтвующему клаÑтеру. При отÑутÑтвии параметра репликаÑет +будет выбран автоматичеÑки на оÑнове зон доÑтупноÑти. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_REPLICASET_ID`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --replicaset-id](cli.md#run_replicaset_id) + +### instance.service_password_file {: #instance_service_password_file } + +Путь к файлу Ñ Ð¿Ð°Ñ€Ð¾Ð»ÐµÐ¼ Ð´Ð»Ñ ÑиÑтемного Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ `pico_service`. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `null` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_SERVICE_PASSWORD_FILE`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --service-password-file](cli.md#run_service_password_file) + +### instance.shredding {: #instance_shredding } + +Режим безопаÑного ÑƒÐ´Ð°Ð»ÐµÐ½Ð¸Ñ [рабочих файлов инÑтанÑа][runfiles] путем +многократной перезапиÑи Ñпециальными битовыми поÑледовательноÑÑ‚Ñми, Ñм. +[БезопаÑный запуÑк](../tutorial/run.md#secure_run). + +[runfiles]: ../architecture/instance_runtime_files.md + +Данные: + +* Тип: *bool* +* Значение по умолчанию: `false` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_SHREDDING`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --shredding](cli.md#run_shredding) + +### instance.tier {: #instance_tier } + +Ð˜Ð¼Ñ [тира](../overview/glossary.md#tier), которому будет принадлежать +инÑтанÑ. ИÑпользуетÑÑ Ð¿Ñ€Ð¸ инициализации клаÑтера и приÑоединении +инÑтанÑа к уже ÑущеÑтвующему клаÑтеру. + +Данные: + +* Тип: *str* +* Значение по умолчанию: `default` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_INSTANCE_TIER`<br> +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð°: +[picodata run --tier](cli.md#run_tier) + ### instance.vinyl.cache {: #instance_vinyl_cache } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-vinyl-cache --> @@ -258,6 +593,13 @@ SSL-Ñертификаты: * Тип: *int* * Значение по умолчанию: `134217728` (128 МБ) +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.vinyl.cache=268435456 +``` + ### instance.vinyl.memory {: #instance_vinyl_memory } <!-- https://www.tarantool.io/en/doc/2.11/reference/configuration/#cfg-storage-vinyl-memory --> @@ -268,3 +610,10 @@ SSL-Ñертификаты: * Тип: *int* * Значение по умолчанию: `134217728` (128 МБ) + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ ÐºÐ¾Ð¼Ð°Ð½Ð´Ð° — +[picodata run --config-parameter](cli.md#run_config_parameter). Пример: + +```bash +picodata run -c instance.vinyl.memory=268435456 +```