# YaK User Documentation ## YaK Release 2.1 - [Welcome](https://dbi-services.gitbook.io/yak-user-doc/readme.md): YaK 2.1 is out! Discover what's new - [Introduction](https://dbi-services.gitbook.io/yak-user-doc/introduction.md): What is YaK? - [YaK Core](https://dbi-services.gitbook.io/yak-user-doc/introduction/yak-core.md) - [YaK Components](https://dbi-services.gitbook.io/yak-user-doc/introduction/yak-components.md) - [Terms and definitions](https://dbi-services.gitbook.io/yak-user-doc/introduction/terms-and-definitions.md) - [Customer Portal](https://dbi-services.gitbook.io/yak-user-doc/customer-portal.md): This section is reserved to customers with a valid subscription to dbi services customer portal. - [User interface](https://dbi-services.gitbook.io/yak-user-doc/user-interface.md) - [Dashboard](https://dbi-services.gitbook.io/yak-user-doc/user-interface/dashboard.md) - [Infrastructures](https://dbi-services.gitbook.io/yak-user-doc/user-interface/menu.md) - [Servers](https://dbi-services.gitbook.io/yak-user-doc/user-interface/servers.md) - [Components](https://dbi-services.gitbook.io/yak-user-doc/user-interface/components.md) - [Jobs](https://dbi-services.gitbook.io/yak-user-doc/user-interface/jobs.md) - [Configuration](https://dbi-services.gitbook.io/yak-user-doc/user-interface/configuration.md) - [Administration](https://dbi-services.gitbook.io/yak-user-doc/user-interface/marketplace.md) - [Copy of Administration](https://dbi-services.gitbook.io/yak-user-doc/user-interface/marketplace-1.md) - [YaK Demo](https://dbi-services.gitbook.io/yak-user-doc/yak-demo.md) - [Versioning & Compatibility matrix](https://dbi-services.gitbook.io/yak-user-doc/versioning.md) - [Release Notes](https://dbi-services.gitbook.io/yak-user-doc/release-notes.md) - [YaK Core](https://dbi-services.gitbook.io/yak-user-doc/release-notes/yak-core.md): This section describes the YaK Core release notes - [YaK components types](https://dbi-services.gitbook.io/yak-user-doc/release-notes/components.md): This section describes the YaK Components release notes - [PostgreSQL](https://dbi-services.gitbook.io/yak-user-doc/release-notes/components/postgresql.md) - [Oracle](https://dbi-services.gitbook.io/yak-user-doc/release-notes/components/oracle.md) - [MongoDB](https://dbi-services.gitbook.io/yak-user-doc/release-notes/components/mongodb.md) - [Kubernetes](https://dbi-services.gitbook.io/yak-user-doc/release-notes/components/kubernetes.md) - [Installation](https://dbi-services.gitbook.io/yak-user-doc/installation.md) - [System requirements](https://dbi-services.gitbook.io/yak-user-doc/installation/system-requirements.md) - [Install YaK Core](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core.md) - [Generate registry authentication secrets and create namepace](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/yak-core.md): (This step is only required as long as the registry is private - will not be necessary when registry will be public) - [Install YaK on your own K8S cluster](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/install-yak.md): Follow this procedure to install the YaK on your Kubernetes cluster. - [Install YaK on Rancher Desktop](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/install-yak-on-rancher-desktop.md): YaK may be locally installed using Rancher Desktop (for testing or development purpose from a workstation for example). We do not recommend using this setup for production. - [Uninstall Yak](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/uninstall-yak.md) - [Install YaK PostgreSQL](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/install-yak-postgresql.md) - [Install YaK Graphile](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/install-yak-graphile.md) - [Install YaK Runner](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/install-yak-runner.md) - [Install YaK UI](https://dbi-services.gitbook.io/yak-user-doc/installation/install-yak-core/install-yak-ui.md) - [YaK Component types](https://dbi-services.gitbook.io/yak-user-doc/installation/yak-components.md) - [YaK step-by-step usage](https://dbi-services.gitbook.io/yak-user-doc/yak-step-by-step-usage.md) - [Configuration](https://dbi-services.gitbook.io/yak-user-doc/configuration.md) - [Secrets](https://dbi-services.gitbook.io/yak-user-doc/configuration/manage-secrets.md): This sections explains how to feed the YaK with secrets - [Templates](https://dbi-services.gitbook.io/yak-user-doc/configuration/templates.md) - [Provider shapes](https://dbi-services.gitbook.io/yak-user-doc/configuration/shapes.md) - [Provider images](https://dbi-services.gitbook.io/yak-user-doc/configuration/images.md) - [Artifact providers](https://dbi-services.gitbook.io/yak-user-doc/configuration/manage-artifact-providers.md) - [Manage infrastructures](https://dbi-services.gitbook.io/yak-user-doc/manage-infrastructures.md) - [Declare infrastructures](https://dbi-services.gitbook.io/yak-user-doc/manage-infrastructures/manage-infrastructure.md): How to declare an infrastructure? - [Attach Secrets](https://dbi-services.gitbook.io/yak-user-doc/manage-infrastructures/attach-secrets.md) - [Detach Secrets](https://dbi-services.gitbook.io/yak-user-doc/manage-infrastructures/detach-secrets.md) - [Manage Servers](https://dbi-services.gitbook.io/yak-user-doc/manage-servers.md) - [Declare servers](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/declare.md) - [Basics](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/declare/basics.md) - [Storage](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/declare/storage.md) - [Attach secrets](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/declare/attach-secrets.md) - [Edit server configuration](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/edit.md) - [Deploy servers](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/deploy.md) - [Destroy servers](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/destroy.md) - [Delete servers](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/delete.md) - [Start / Stop servers](https://dbi-services.gitbook.io/yak-user-doc/manage-servers/start-stop.md) - [Manage Components](https://dbi-services.gitbook.io/yak-user-doc/manage-components.md) - [Component types overview](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types-overview.md) - [Artifacts requirements](https://dbi-services.gitbook.io/yak-user-doc/manage-components/artifacts-requirements.md) - [Declare a component](https://dbi-services.gitbook.io/yak-user-doc/manage-components/declare.md) - [Edit a component](https://dbi-services.gitbook.io/yak-user-doc/manage-components/edit.md) - [Deploy a component](https://dbi-services.gitbook.io/yak-user-doc/manage-components/deploy.md) - [Destroy a component](https://dbi-services.gitbook.io/yak-user-doc/manage-components/destroy.md) - [Delete a component](https://dbi-services.gitbook.io/yak-user-doc/manage-components/delete.md) - [Component types](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types.md) - [PostgreSQL](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql.md) - [Description](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/description.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references.md) - [PostgreSQL 2.0.0](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references/component-references.md) - [Standalone deployment variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references/component-references/standalone-deployment-variables.md) - [HA deployment variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references/component-references/ha-deployment-variables.md) - [PostgreSQL 2.1.0](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references/component-references-1.md) - [Standalone deployment variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references/component-references-1/standalone-deployment-variables.md) - [HA deployment variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/postgresql/component-references/component-references-1/ha-deployment-variables.md) - [Oracle](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template.md) - [Description](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/description.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/component-references.md) - [Oracle 2.0.0](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/component-references/oracle-2.0.0.md) - [Standalone variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/component-references/oracle-2.0.0/standalone-deployment-variables.md) - [Oracle 2.1.0](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/component-references/oracle-2.0.0-1.md) - [Standalone variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/component-references/oracle-2.0.0-1/standalone-deployment-variables.md) - [HA variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/component-template/component-references/oracle-2.0.0-1/standalone-deployment-variables-1.md) - [MongoDB](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb.md) - [Description](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb/description.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb/component-references.md) - [MongoDB 2.0.0](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb/component-references/mongodb-2.0.0.md) - [Single instance variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb/component-references/mongodb-2.0.0/single-instance-variables.md) - [Replicaset variables](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/mongodb/component-references/mongodb-2.0.0/replicaset-variables.md) - [Kubernetes](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/kubernetes.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/kubernetes/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/manage-components/component-types/kubernetes/component-references.md) - [Templates](https://dbi-services.gitbook.io/yak-user-doc/manage-components/templates.md) - [Storage](https://dbi-services.gitbook.io/yak-user-doc/manage-components/templates/storage.md) - [Components](https://dbi-services.gitbook.io/yak-user-doc/manage-components/templates/components.md) - [Use cases](https://dbi-services.gitbook.io/yak-user-doc/quickstarts.md) - [On-Premises](https://dbi-services.gitbook.io/yak-user-doc/quickstarts/on-premises.md): In this section, we will guide you through the declaration of a completely functional on-prem infrastructure. - [AWS](https://dbi-services.gitbook.io/yak-user-doc/quickstarts/aws.md): In this section, we will guide you through the deployment of a completely functional infrastructure on AWS. - [Azure](https://dbi-services.gitbook.io/yak-user-doc/quickstarts/azure.md): In this section, we will guide you through the deployment of a completely functional infrastructure on Azure. - [OCI](https://dbi-services.gitbook.io/yak-user-doc/quickstarts/oci.md): In this section, we will guide you through the deployment of a completely functional infrastructure on OCI. - [Component (Draft)](https://dbi-services.gitbook.io/yak-user-doc/quickstarts/component.md) - [Backup and restore](https://dbi-services.gitbook.io/yak-user-doc/backup-and-restore.md) - [API references](https://dbi-services.gitbook.io/yak-user-doc/api-references.md) - [API references](https://dbi-services.gitbook.io/yak-user-doc/api-references/api-references.md) - [Appendix](https://dbi-services.gitbook.io/yak-user-doc/appendix.md) - [Create SSH Keys with PuTTYgen](https://dbi-services.gitbook.io/yak-user-doc/appendix/create-ssh-keys-with-puttygen.md) - [Roles](https://dbi-services.gitbook.io/yak-user-doc/appendix/roles.md): YaK comes with 4 roles : "Administrator", "Owner", "User" and "Viewer". Each of these roles confers specific privileges, as described in the tables below. ## YaK Release 2.0 - [Welcome](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/readme.md) - [Introduction](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/introduction.md): What is YaK? - [YaK Core](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/introduction/yak-core.md) - [YaK Components](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/introduction/yak-components.md) - [Terms and definitions](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/introduction/terms-and-definitions.md) - [YaK Demo](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/introduction/yak-demo.md) - [Customer Portal](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/customer-portal.md): This section is reserved to customers with a valid subscription to dbi services customer portal. - [User interface](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface.md) - [Dashboard](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/dashboard.md) - [Infrastructures](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/menu.md) - [Servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/servers.md) - [Components](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/components.md) - [Jobs](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/jobs.md) - [Configuration](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/configuration.md) - [Administration](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/marketplace.md) - [Copy of Administration](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/user-interface/marketplace-1.md) - [Versioning & Compatibility matrix](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/versioning.md) - [Release Notes](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes.md) - [YaK Core](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes/yak-core.md): This section describes the YaK Core release notes - [YaK components types](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes/components.md): This section describes the YaK Components release notes - [PostgreSQL](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes/components/postgresql.md) - [Oracle](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes/components/oracle.md) - [MongoDB](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes/components/mongodb.md) - [Kubernetes](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/release-notes/components/kubernetes.md) - [Installation](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation.md) - [System requirements](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/system-requirements.md) - [Install YaK Core](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core.md) - [Generate registry authentication secrets and create namepace](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/yak-core.md): (This step is only required as long as the registry is private - will not be necessary when registry will be public) - [Install YaK on your own K8S cluster](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/install-yak.md): Follow this procedure to install the YaK on your Kubernetes cluster. - [Install YaK on Rancher Desktop](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/install-yak-on-rancher-desktop.md): YaK may be locally installed using Rancher Desktop (for testing or development purpose from a workstation for example). We do not recommend using this setup for production. - [Uninstall Yak](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/uninstall-yak.md) - [Install YaK PostgreSQL](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/install-yak-postgresql.md) - [Install YaK Graphile](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/install-yak-graphile.md) - [Install YaK Runner](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/install-yak-runner.md) - [Install YaK UI](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/install-yak-core/install-yak-ui.md) - [YaK Component types](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/installation/yak-components.md) - [YaK step-by-step usage](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/yak-step-by-step-usage.md) - [Configuration](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/configuration.md) - [Secrets](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/configuration/manage-secrets.md): This sections explains how to feed the YaK with secrets - [Templates](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/configuration/templates.md) - [Provider shapes](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/configuration/shapes.md) - [Provider images](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/configuration/images.md) - [Artifact providers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/configuration/manage-artifact-providers.md) - [Manage infrastructures](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-infrastructures.md) - [Declare infrastructures](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-infrastructures/manage-infrastructure.md): How to declare an infrastructure? - [Attach Secrets](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-infrastructures/attach-secrets.md) - [Detach Secrets](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-infrastructures/detach-secrets.md) - [Manage Servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers.md) - [Declare servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/declare.md) - [Basics](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/declare/basics.md) - [Storage](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/declare/storage.md) - [Attach secrets](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/declare/attach-secrets.md) - [Edit server configuration](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/edit.md) - [Deploy servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/deploy.md) - [Destroy servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/destroy.md) - [Delete servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/delete.md) - [Start / Stop servers](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-servers/start-stop.md) - [Manage Components](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components.md) - [Component types overview](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types-overview.md) - [Artifacts requirements](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/artifacts-requirements.md) - [Declare a component](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/declare.md) - [Edit a component](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/edit.md) - [Deploy a component](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/deploy.md) - [Destroy a component](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/destroy.md) - [Delete a component](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/delete.md) - [Component types](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types.md) - [PostgreSQL](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql.md) - [Description](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql/description.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql/component-references.md) - [PostgreSQL 2.0.0](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql/component-references/component-references.md) - [Standalone deployment variables](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql/component-references/component-references/standalone-deployment-variables.md) - [HA deployment variables](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/postgresql/component-references/component-references/ha-deployment-variables.md) - [Oracle](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/component-template.md) - [Description](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/component-template/description.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/component-template/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/component-template/component-references.md) - [Oracle 2.0.0](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/component-template/component-references/oracle-2.0.0.md) - [Standalone deployment variables](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/component-template/component-references/oracle-2.0.0/standalone-deployment-variables.md) - [MongoDB](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/mongodb.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/mongodb/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/mongodb/component-references.md) - [Kubernetes](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/kubernetes.md) - [Pre-requisites](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/kubernetes/pre-requisites.md) - [Component references](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/component-types/kubernetes/component-references.md) - [Templates](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/templates.md) - [Storage](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/templates/storage.md) - [Components](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/manage-components/templates/components.md) - [Use cases](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/quickstarts.md) - [AWS](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/quickstarts/aws.md): In this section, we will guide you through the deployment of a completely functional infrastructure on AWS. - [Azure](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/quickstarts/aws-1.md): In this section, we will guide you through the deployment of a completely functional infrastructure on Azure. - [OCI](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/quickstarts/aws-2.md): In this section, we will guide you through the deployment of a completely functional infrastructure on OCI. - [Component (Draft)](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/quickstarts/component.md) - [Backup and restore](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/backup-and-restore.md) - [API references](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/api-references.md) - [Complete API references](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/api-references/complete_api_reference.md) - [Appendix](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/appendix.md) - [Roles](https://dbi-services.gitbook.io/yak-user-doc/yak-release-2.0/appendix/roles.md): YaK comes with 4 roles : "Administrator", "Owner", "User" and "Viewer". Each of these roles confers specific privileges, as described in the tables below. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://dbi-services.gitbook.io/yak-user-doc/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.