From 12d3877ddb4a0f60b71b13aec9429989324c04f2 Mon Sep 17 00:00:00 2001
From: Arinda Arif <79823430+arinda-arif@users.noreply.github.com>
Date: Tue, 21 Dec 2021 11:17:24 +0700
Subject: [PATCH] docs: modify optimus configuration sample (#127)

* doc: modify optimus configuration sample

* docs: add possible backup configurations
---
 .optimus.sample.yaml                       | 33 ++++++++------
 docs/docs/getting-started/configuration.md | 51 +++++++++++++++-------
 2 files changed, 54 insertions(+), 30 deletions(-)

diff --git a/.optimus.sample.yaml b/.optimus.sample.yaml
index 30bcd6675f..9a46c4c758 100644
--- a/.optimus.sample.yaml
+++ b/.optimus.sample.yaml
@@ -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
diff --git a/docs/docs/getting-started/configuration.md b/docs/docs/getting-started/configuration.md
index 7b0fcfc35c..bea17952ce 100644
--- a/docs/docs/getting-started/configuration.md
+++ b/docs/docs/getting-started/configuration.md
@@ -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: