User Guide ########## Tutorial ======== Fast Start with ADB ------------------- **Goal**: * Run a backup job on ADB cluster with ADSS **Prerequisite**: * You have ADSS and ADB installed. **Script**: * Login to ADSS * Add filesystem: * Go to: :ref:`ui_main_menu` -> :ref:`FILE SYSTEM` -> *Add File System* button * Choose required File System Type * Enter name * Enter display name * Click *Add* button * Increase number of parallel operation on File System: * Go to: :ref:`ui_main_menu` -> :ref:`FILE SYSTEM` -> Click on exact File System line * Go to: *Left Menu* -> *Capacity* * Increase a number of parallel operations by type of operations. * Click *Update* button * Add Cluster * Go to :ref:`ui_main_menu` -> :ref:`CLUSTERS` -> *Add cluster* button * Fill the following fields: * *name* with fqdn like name of cluster * *display name* with name in any free format * set *cluster type* to "Arenadata DB" * set *Master Host Adress* to ip or FQDN of master host in ADB cluster * set ADB related system user (gpadmin usually) name which has access to gpbackup/gprestore execution * set user password or user privite key to connect to master host over ssh * Mount FS to Cluster * Go to :ref:`ui_main_menu` -> :ref:`CLUSTERS` -> Click on line with your ADB cluster * Go to *Left menu* -> *Mount points* * Click *Add Mount point* * Choose your File System * Enter the place this file system mounted on every host in ADB. * Click *Add* * Increase number of parallel operations on cluster * Go to :ref:`ui_main_menu` -> :ref:`CLUSTERS` -> Click on line with your ADB cluster * Go to: *Left Menu* -> *Capacity* * Increase a number of parallel operations by type of operations. * Click *Update* button * Spawn "on demand" backup job for your ADB cluster: * Go to :ref:`ui_main_menu` -> :ref:`JOBS` -> *Add job Queue* button * Enter job name * Enter job display name * Choose cluster from list * Choose file system from list * Set handler type to "ADB backup handler" * Set DB Name to a name of database you want to backup * Set Schema to a name of schema you want to backup * Set Table to a name of table you want to backup * Set Threads to a number of parallel operations during backup (take a note, that this value should not exceed the number of parallel operation allowed for cluster and filesystem) * Set compression level * Set if this table backup should be a full * Click *Add* * Watch for Job to end * Go to :ref:`ui_main_menu` -> :ref:`JOBS` -> *Add job Queue* button * Find your job * Wait for it to be finished. UI in Details ============= .. _ui_main_menu: Main Menu --------- **Location**: On top of every page. .. image:: img/ui_main_menu.png :alt: UI Main Menu There are a number of links in the Main Menu. These links represent corresponding main objects in ADSS: * "CLUSTERS" * "FILE SYSTEMS" * "CRON LINE" * "JOBS" Link hightlited with "orange" (like "JOBS" in the screenshot above is a current page**. .. _ui_cluster_list_view: Cluster List View ----------------- **Location**: :ref:`ui_main_menu` -> "CLUSTERS** List of all clusters controlled by ADSS .. image:: img/ui_cluster_list_view.png :alt: Cluster List View For every cluster on this view you could do the following operation: * Remove cluster with a button at right on every line in grid * Go to Cluster Details View with a click anywhere on line in grid Besides you could add new cluster to ADSS with "Add Cluster" button. .. _ui_filesystem_list_view: File System List View --------------------- **Location**: :ref:`ui_main_menu` -> "FILE SYSTEM" List of all file systems controlled by ADSS. .. image:: img/ui_fs_list_view.png :alt: Filesystem List View For every Filesystem on this view you could do the following operation: * Remove Filesystem with a button at right on every line in grid * Go to Filesystem Details View with a click anywhere on line in grid Besides you could add new filesystem to ADSS with "Add Filesystem" button. .. _ui_cronline_list_view: Cronline List View -------------------- **Location**: :ref:`ui_main_menu` -> "CRON LINE" Lis of all "cronlines" controlled by ADSS. Cron line is a type of scheduler. Every line here is an operation which could be repeated according to rules provided in form of extended cronline format .. image:: img/ui_cronline_list_view.png :alt: Cronline List View For every cronline on this view you could do the following operation: * Remove cronline with a button at right on every line in grid * Go to Cronline Details View with a click anywhere on line in grid * View cron line * View state * Go to related cluster * Go to related file system Besides you could add new cronline to ADSS with "Add Cronline" button. .. _ui_job_list_view: Job List View ------------- **Location**: :ref:`ui_main_menu` -> "JOBS" List of all jobs runned by ADSS. .. image:: img/ui_job_list_view.png :alt: Job List View This view diveded on two parts: * List of "in progress" Jobs * List of finished jobs There are following operations for every job available: * View state of job. * View information about date of creation, starting and finishing (only in history part). * Go to related Cluster, Filesystem or Cronline (if job was run from cronline) * Kill the job with button on the right (for active jobs only) There is also "Add Job Queue" button to create "on demand" job. This type of job is running only once. If you need a repeatable job you have to go to Cronline. There is also a quick filter on the upper right allows you to filter job created "on demand** and created by cronline. .. _ui_cluster_details_view: Cluster Details View -------------------- **Location** :ref:`ui_main_menu` -> :ref:`CLUSTERS` -> *Click on line in grid* .. image:: img/ui_cluster_details_view.png :alt: Cluster Details View This is a page created to view and modify information about one particular cluster. There is a number of links in Left Menu you could use to navigate inside a cluster: * *Settings* - default page with some parameters one can change * *Mount points* - information about connection between File System and Cluster * *Jobs* - any job related to the cluster. This page equal to :ref:`ui_job_list_view` but this page shows only exact cluster related jobs. * *Cron line* - any cron lines related to the clusters. This page equal to :ref:`ui_cronline_list_view` * *Capacity* - is a page with information about cluster capacity against some type of operations. .. _ui_filesystem_details_view: File System Details View ------------------------ **Location** :ref:`ui_main_menu` -> :ref:`FILE SYSTEM` -> *Click on line in grid* .. image:: img/ui_filesystem_details_view.png :alt: Filesystem Details View This is a page created to view and modify information about one particular filesystem. There is a number of links in Left Menu you could use to navigate inside a filesystem: * *Settings* - default page with some parameters one can change * *Jobs* - any job related to the filesystem. This page equal to :ref:`ui_job_list_view` but this page shows only exact filesystem related jobs. * *Cron line* - any cron lines related to the filesystems. This page equal to :ref:`ui_cronline_list_view` * *Capacity* - is a page with information about filesystem capacity against some type of operations. .. _ui_cronline_details_view: Cron Line Details View ---------------------- **Location** :ref:`ui_main_menu` -> :ref:`CRON LINE` -> *Click on line in grid* .. image:: img/ui_cronline_details_view.png :alt: Cronline Details View This is a page to view and mofify information about one cron line entry. There is two links in Left Menu you could use to navigate inside a cron line: * *Settings* - default page with some parameters one can change * *Jobs* - any job related to the filesystem. This page equal to :ref:`ui_job_list_view` but this page shows only jobs created from this cron line. .. _ui_job_details_view: Job Details View ---------------- **Location** :ref:`ui_main_menu` -> :ref:`JOBS` -> *Click on line in grid* .. image:: img/ui_job_details_view.png :alt: Job Details View This is a page with details about one job. There is a number of links on Left Menu: * *Settings* - readonly view with all paramenters of a job. * ** - a number of links to a logs of job.