YaK User Documentation
YaK Landing PageVisit dbi-services.comContact us
YaK Release 2.1
YaK Release 2.1
  • Welcome
  • Introduction
    • YaK Core
    • YaK Components
    • Terms and definitions
  • User interface
    • Dashboard
    • Infrastructures
    • Servers
    • Components
    • Jobs
    • Configuration
    • Administration
  • YaK Demo
  • Versioning & Compatibility matrix
  • Release Notes
    • YaK components types
      • PostgreSQL
      • Oracle
  • Installation
    • System requirements
    • Install YaK Core
      • Install YaK on your own K8S cluster
      • Install YaK on Rancher Desktop
      • Uninstall Yak
  • YaK step-by-step usage
  • Configuration
    • Secrets
    • Templates
    • Provider shapes
    • Provider images
    • Artifact providers
  • Manage infrastructures
    • Declare infrastructures
    • Attach Secrets
    • Detach Secrets
  • Manage Servers
    • Declare servers
      • Basics
      • Storage
      • Attach secrets
    • Edit server configuration
    • Deploy servers
    • Destroy servers
    • Delete servers
    • Start / Stop servers
  • Manage Components
    • Artifacts requirements
    • Component types
      • PostgreSQL
        • Description
        • Pre-requisites
        • Component references
          • PostgreSQL 2.0.0
            • Standalone deployment variables
            • HA deployment variables
      • Oracle
        • Description
        • Pre-requisites
        • Component references
          • Oracle 2.0.0
            • Standalone variables
  • Use cases
    • On-Premises
    • AWS
    • Azure
    • OCI
  • Appendix
    • Create SSH Keys with PuTTYgen
    • Roles
Powered by GitBook
On this page
  • Wanna give it a try?
  • Limitations
  • YaK Login Page
  • Where to start?
  • What you need to do now
  • 1. Declare a SSH key
  • 2. Attach your SSH key to the infrastructure
  • 3. Declare a server
  • 4. Deploy your server
  • 5. Declare your component
  • 6. Deploy your component
  • 7. Connect to your server and play around

YaK Demo

PreviousAdministrationNextVersioning & Compatibility matrix

Last updated 6 days ago

dbi services makes free demo environments available to all, so that you can play with the YaK and deploy instances and components to Azure and AWS. The Yak Demo environment is hosted on one of dbi services AWS tenants and is automatically destroyed after 4 hours.

The demo environment is not supposed to be used for production purpose (it’s just a demo and everything is scrubbed after 4 hours)

dbi services shall not be held liable for any data loss on this demo environment

Wanna give it a try?

To do so, simply connect to , fill in the form and you will receive a confirmation email from no-reply@dbi-services.com.

Please allow 5 to 10 minutes for the environment to be provisioned and the YaK to spin up. Once up and running you'll receive a second email from no-reply@demo.yak4all.io with the URL to connect to your YaK.

Check your inbox and junk mail to make sure you don't miss out on your YaK experience!

Limitations

The demo environment we provision comes with the following restrictions (this will not be the case with a regular installation of YaK):

AWS infrastructure:

  • Available shapes: t3.micro, t3.small, t3.medium

  • Available disk types: gp2, gp3

  • Disk sizes: max 50gb

  • Available component: PostgreSQL

  • AWS Region: eu-west-1

Azure infrastructure:

  • Available shapes: Standard_B2s, Standard_B2ms

  • Available disk types: Standard_LRS, StandardSSD_LRS

  • Disk sizes: max 64gb

  • Available component: PostgreSQL

YaK Login Page

Open the link received and log into the YaK.

  • Login: admin

  • Password: ABCdef1234@

Where to start?

Alright, you're all set, your environment is ready. Let's give it a try!

We have pre-provisioned the YaK with a few things for you so that you can almost immediately deploy your servers and components:

  • 2 infrastructures have been pre-provisioned:

    • An AWS demo infrastructure: "aws-demo-1"

    • A Microsoft Azure demo infrastructure: "azure-demo-1"

  • Cloud providers secrets have been attached to these infrastructures

  • A PostgreSQL component type is available to you

What you need to do now

Well, we've thought of a scenario, but feel free to explore the YaK on your own if you prefer.

Our use case here is to deploy a server to AWS or to Azure and then deploy a PostgreSQL database instance on it.

1. Declare a SSH key

In order to connect securely to the Linux servers once created, a pair of SSH keys must be generated and the private key must be transferred to the servers.

  1. Generate your SSH key:

SSH keys can be generated from any Linux-based machine running openSSH with the "ssh-keygen" command.

Example:

$ ssh-keygen -b 4096 -m PEM -t rsa -f my-ssh-key -q -N ""

  1. Copy the content of the private key file:

$ cat my-ssh-key
##This is just an example, generate your own private key

-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAACmFlczI1Ni1jdHIAAAAGYmNyeXB0AAAAGAAAABASDILVb1
MiZ78g848c6Dk6KYwkJZXloSIruLe+Sid0Xd+Lb1rAxbwzAhXWRMzzBT5k3WciXk2fMhUD
p4YSahpYvquZK950aXiZNDOJpKZP8wjf4g4nQyiJZ/0G0J9mIaI2h/fr8TA67KHYtu/Eyf
PN9bKJwII3aiGlu5/Viq2cgYT8jJ01AK8cY3tSqKdlrN2GyxllBFl42QplbxA2USPJ1E6v
VIjtbmJjdz[...........................................]qAc4HxP02t/N2ZN
q+dDNWeShfVz4zjApPQCzdiGqLAlzUy67KNxQgljhaOEaYTQgrLE8XNGsIFNZwGvsEo/xZ
XnN2p
-----END OPENSSH PRIVATE KEY-----
  1. Feed the YaK with the SSH key:

    • From the menu, navigate to Configuration -> Secrets

    • Click "Declare"

    • Give a name to your secret (my-ssh-key)

    • Select "ssh key" as secret type

  2. Paste the entirety of the private key previously copied, into the corresponding field of the form

  3. Click "Save"

2. Attach your SSH key to the infrastructure

  • From the menu, navigate to "Infrastructures"

  • Select the infrastructure you would like to deploy to in the list ("aws-demo-1" or "azure-demo-1")

  • Click the "Action" button

  • Click "Attach secret"

  • Select the SSH secret created in the previous step from the list

  • Click "Attach"

3. Declare a server

  • Navigate to the "Servers" menu

  • Click "Declare"

  • Give it a name

  • Select the Infrastructure to deploy your server to ("aws-demo-1" or "azure-demo-1")

  • Select an Image to install : let's take Debian 12 for example

  • Select a server Shape

  • Add custom tags as per your need (optional)

  • Network section:

    • Mode: automatic

    • IP: leave blank

    • Scope: public

    • Tick the "Admin access" checkbox: this defines the IP address used to connect to the server for configuration purpose.

  • Click Save

In Azure, VM names must be unique. Since we're all sharing the same demo environment, avoid instance names that are too obvious and could conflict with other users' machines, such as “srv01”, ‘server1’, “myserver”, etc. Be creative to avoid potential conflicts with other users 😉

4. Deploy your server

  • Select your server in the list

  • Click "Deploy" from the "Actions" menu

  • Confirm "Deploy" in the pop up box

  • Wait until the job status is "Successful"

  • Your server should be automatically started and is now in a "running" state

    • But hold your horses! Let's deploy a component on it! (if you can't wait, skip the component deployment and come back to it later, that's OK)

5. Declare your component

  • Navigate to the "Components" menu

  • Click "Declare"

  • Give it a name (ex: PG01)

  • Select your component type (postgresql_instance)

  • Select your subcomponent type (standalone)

    • HA requires 3 servers be deployed, in this example we will consider a standalone setup as we have declared 1 server only

  • Choose your Provider (here it will be aws or azure)

  • Select the PostgreSQL host where you want to deploy your database instance (the server created previously)

  • Fill in the "Instance name" field (ex: mypgdb)

  • Navigate to the "Storage" tab and fill in the required fields.

    • Set Max size of component disks for the 3 file systems:

      • /u01 -> 40GB

      • /u02 -> 20GB

      • /u90 -> 20GB

  • Click "Save"

6. Deploy your component

  • Your PostgreSQL database instance is configured, now let's deploy it:

    • Select the component you've just configured from the list

    • Click "Actions"

    • Then click "Deploy a new PostgreSQL Standalone instance"

    • Confirm your choice in the pop-up menu

    • Seat back, relax, follow the deployment steps from the jobs menu and wait until your component is successfully installed and configured.

7. Connect to your server and play around

  • Open a SSH connection to the public IP address of your server:

DEMOUSER@demo$ ssh -i my-ssh-key <user>@<PUBLIC_IP>
  • Your public IP address can be retrieved from Servers -> Parameters

  • User:

    • Azure default user is azureuser

    • AWS default users:

      • The default user for debian based AMI is "admin", but this could be something else, based on the AMI you selected:

        • For an Amazon Linux AMI, the username is ec2-user.

          • For a CentOS AMI, the username is centos or ec2-user.

            • For a Debian AMI, the username is admin.

            • For a Fedora AMI, the username is fedora or ec2-user.

            • For a RHEL AMI, the username is ec2-user or root.

            • For a SUSE AMI, the username is ec2-user or root.

            • For an Ubuntu AMI, the username is ubuntu.

            • For an Oracle AMI, the username is ec2-user.

            • For a Bitnami AMI, the username is bitnami.

  • Play with your PostgreSQL database instance!

admin@my-server1:~$ sudo su - postgres


 PostgreSQL Clusters up and running on this host:
 ----------------------------------------------------------------------------------------------
    mypgdb      ->  /u02/pgdata/17/mypgdb                                    ->  5432  ==> OPEN

 PostgreSQL Clusters NOT running on this host:
 ----------------------------------------------------------------------------------------------

16:39:13 postgres@my-server1:/home/postgres/ [pg17.2] psql -p 5432
psql (17.2 dbi services build)
Type "help" for help.

postgres=#

Windows users can generate SSH keys using the PuTTYgen utility (see )

Follow the deployment steps from the Jobs menu to see what the YaK is doing behind the scene. If you've followed the steps it should succeed (if not you must have missed something )

You should already be able to connect to it via SSH by selecting the server and retrieving the public IP from the server parameters. (see step "")

Reference :

😄
https://yak4all.io/demo/
appendix
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managing-users.html
connect to your server