diff --git a/deployment.html b/deployment.html index d750ad13..8ee16abc 100644 --- a/deployment.html +++ b/deployment.html @@ -107,21 +107,21 @@

Settings same name, prefixed with EXODUS_GW_ (example: EXODUS_GW_CALL_CONTEXT_HEADER).

-call_context_header: str
+call_context_header: str

Name of the header from which to extract call context (for authentication and authorization).

-upload_meta_fields: dict[str, str]
+upload_meta_fields: dict[str, str]

Permitted metadata field names for s3 uploads and their regex for validation. E.g., “exodus-migration-md5”: “^[0-9a-f]{32}$”

-publish_paths: dict[str, dict[str, list[str]]]
+publish_paths: dict[str, dict[str, list[str]]]

A set of user or service accounts which are only authorized to publish to a particular set of path(s) in a given CDN environment and the regex(es) describing the paths to which the user or service account is authorized to publish. The user or @@ -135,49 +135,49 @@

Settings
-log_config: dict[str, Any]
+log_config: dict[str, Any]

Logging configuration in dictConfig schema.

-ini_path: str | None
+ini_path: str | None

Path to an exodus-gw.ini config file with additional settings.

-db_service_user: str
+db_service_user: str

db service user name

-db_service_pass: str
+db_service_pass: str

db service user password

-db_service_host: str
+db_service_host: str

db service host

-db_service_port: str
+db_service_port: str

db service port

-db_url: str | None
+db_url: str | None

Connection string for database. If set, overrides the db_service_* settings.

-db_reset: bool
+db_reset: bool

If set to True, drop all DB tables during startup.

This setting is intended for use during development.

@@ -207,64 +207,64 @@

Settings
-db_migration_revision: str
+db_migration_revision: str

If db_migration_mode is upgrade, this setting can be used to override the target revision when migrating the DB.

-db_session_max_tries: int
+db_session_max_tries: int

The maximum number of attempts to recreate a DB session within a request.

-item_yield_size: int
+item_yield_size: int

Number of publish items to load from the service DB at one time.

-write_batch_size: int
+write_batch_size: int

Maximum number of items to write to the DynamoDB table at one time.

-write_max_tries: int
+write_max_tries: int

Maximum write attempts to the DynamoDB table.

-write_max_workers: int
+write_max_workers: int

Maximum number of worker threads used in the DynamoDB batch writes.

-write_queue_size: int
+write_queue_size: int

Maximum number of items the queue can hold at one time.

-write_queue_timeout: int
+write_queue_timeout: int

Maximum amount of time (in seconds) to wait for queue items. Defaults to 10 minutes.

-publish_timeout: int
+publish_timeout: int

Maximum amount of time (in hours) between updates to a pending publish before it will be considered abandoned. Defaults to one day.

-history_timeout: int
+history_timeout: int

Maximum amount of time (in hours) to retain historical data for publishes and tasks. Publishes and tasks in a terminal state will be erased after this time has passed. Defaults to two weeks.

@@ -272,55 +272,55 @@

Settings
-path_history_timeout: int
+path_history_timeout: int

Maximum amount of time (in days) to retain data on published paths for the purpose of cache flushing.

-task_deadline: int
+task_deadline: int

Maximum amount of time (in hours) a task should remain viable. Defaults to two hours.

-actor_time_limit: int
+actor_time_limit: int

Maximum amount of time (in milliseconds) actors may run. Defaults to 30 minutes.

-actor_max_backoff: int
+actor_max_backoff: int

Maximum amount of time (in milliseconds) actors may use while backing off retries. Defaults to five (5) minutes.

-entry_point_files: list[str]
+entry_point_files: list[str]

List of file names that should be saved for last when publishing.

-autoindex_filename: str
+autoindex_filename: str

Filename for indexes automatically generated during publish.

Can be set to an empty string to disable generation of indexes.

-autoindex_partial_excludes: list[str]
+autoindex_partial_excludes: list[str]

Background processing of autoindexes will be disabled for paths matching any of these values.

-config_cache_ttl: int
+config_cache_ttl: int

Time (in minutes) config is expected to live in components that consume it.

Determines the delay for deployment task completion to allow for existing caches to expire and the newly deployed config to take effect.

@@ -328,13 +328,13 @@

Settings
-worker_health_filepath: str
+worker_health_filepath: str

The path to a file used to verify healthiness of a worker. Intended to be used by OCP

-worker_keepalive_timeout: int
+worker_keepalive_timeout: int

Background worker keepalive timeout, in seconds. If a worker fails to update its status within this time period, it is assumed dead.

This setting affects how quickly the system can recover from issues such as a worker @@ -343,13 +343,13 @@

Settings
-worker_keepalive_interval: int
+worker_keepalive_interval: int

How often, in seconds, should background workers update their status.

-cron_cleanup: str
+cron_cleanup: str

cron-style schedule for cleanup task.

exodus-gw will run a cleanup task approximately according to this schedule, removing old data from the system.

@@ -357,7 +357,7 @@

Settings
-scheduler_interval: int
+scheduler_interval: int

How often, in minutes, exodus-gw should check if a scheduled task is ready to run.

Note that the cron rules applied to each scheduled task are only as accurate as this interval allows, i.e. each rule may be triggered up to scheduler_interval minutes late.

@@ -365,14 +365,14 @@

Settings
-scheduler_delay: int
+scheduler_delay: int

Delay, in minutes, after exodus-gw workers start up before any scheduled tasks should run.

-cdn_flush_on_commit: bool
+cdn_flush_on_commit: bool

Whether ‘commit’ tasks should automatically flush CDN cache for affected URLs.

Only takes effect for environments where cache flush credentials/settings @@ -381,26 +381,26 @@

Settings
-cdn_listing_flush: bool
+cdn_listing_flush: bool

Whether listing paths in the config should be flushed while deploying the config.

+cdn_cookie_ttl: int

Time (in seconds) cookies generated by cdn-redirect remain valid.

-cdn_signature_timeout: int
+cdn_signature_timeout: int

Time (in seconds) signed URLs remain valid.

-cdn_max_expire_days: int
+cdn_max_expire_days: int

Maximum permitted value for expire_days option on cdn-access endpoint.

Clients obtaining signed cookies for CDN using cdn-access will be @@ -409,7 +409,7 @@

Settings
-s3_pool_size: int
+s3_pool_size: int

Number of S3 clients to cache