Skip to content

Commit

Permalink
docs: modify optimus configuration sample (#127)
Browse files Browse the repository at this point in the history
* doc: modify optimus configuration sample

* docs: add possible backup configurations
  • Loading branch information
arinda-arif authored Dec 21, 2021
1 parent d84d85b commit 12d3877
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 30 deletions.
33 changes: 19 additions & 14 deletions .optimus.sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,31 @@ log:
# used to connect optimus service
#host: localhost:9100

#jobs:
# # folder where job specifications are stored
# path: "job"

#datastore:
# # optimus is capable of supporting multiple datastores
# type: bigquery
# # path where resource spec for BQ are stored
# path: "bq"

# project variables usable in specifications
#config:
# global:
# for configuring optimus project
#project:
# name: sample_project
# # project variables usable in specifications
# config:
# environment: integration
# scheduler_host: http://example.io/
# # storage_path is used for storing compiled job specifications that can be
# # consumed by schedulers like Airflow
# # it supports multiple schemes like: file://, gcs://
# storage_path: file://absolute_path_to_a_directory
# local: {}

# for configuring optimus namespace
#namespace:
# name: sample_namespace
# jobs:
# # folder where job specifications are stored
# path: "job"
# datastore:
# # optimus is capable of supporting multiple datastores
# type: bigquery
# # path where resource spec for BQ are stored
# path: "bq"
# # namespace variables usable in specifications
# config: {}

#
# server configurations
Expand Down
51 changes: 35 additions & 16 deletions docs/docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,41 @@ version: 1
# used to connect optimus service
host: localhost:9100

jobs:
# folder where job specifications are stored
path: "job"

datastore:
# optimus is capable of supporting multiple datastores
type: bigquery
# path where resource spec for BQ are stored
path: "bq"
# backup configurations of a datastore
backup: {}

# project variables usable in specifications
config:
global:{}
local:{}
# project specification
project:

# name of the Optimus project
name: sample_project

# project level variables usable in specifications
config: {}

# namespace specification of the jobs and resources
namespace:

# namespace name
name: sample_namespace

jobs:
# folder where job specifications are stored
path: "job"

datastore:
# optimus is capable of supporting multiple datastores
type: bigquery
# path where resource spec for BQ are stored
path: "bq"
# backup configurations of a datastore
backup:
# backup result age until expired - default '720h'
ttl: 168h
# where backup result should be located - default 'optimus_backup'
dataset: archive
# backup result prefix table name - default 'backup'
prefix: archive

# namespace level variables usable in specifications
config: {}

# for configuring optimus service locally
serve:
Expand Down

0 comments on commit 12d3877

Please sign in to comment.