# Installation Process

To install the EaaS product, follow the steps below.

# Step 1

Open a command shell (also known as a command prompt, terminal, or command line) of your preference and run the following command:

git clone git@bitbucket.org:kenv-main/eaas_common.git 

️❗️ WARNING

This user guide assumes that all the commands and paths are to be done within Unix-based systems. If you use Windows, consider making corresponding adjustments.

# Step 2

Go to the chart directory of the repository:

/{path_repo_dir}/helms/

# Step 3

In the root folder of the helm chart, locate the .yaml file and enter its values.

Click here to view what values to enter

Parameter Name Type Description Default Value
web_portal_service_type string Way to expose an endpoint of the service deployed by the Helm Chart NodePort
hostname string DNS name required for every EaaS installation. “test.kenv.io”
externaldns bool Set to true when an external DNS service is required false
imageCredentials.registry string URL to a docker image registry (repository) 762216258500.dkr.ecr.eu-central-1.amazonaws.com
imageCredentials.username string Repository username aws
imageCredentials.password string Repository password ****
eaas_username string EaaS API user eaasadmin
eaas_password string EaaS API password *****
job_retention string K8S_JOB_RETENTION_PERIOD; represents time to cleanup old jobs "259200"
eaas_module_handler_image string Image name with the tag for a handler container 762216258500.dkr.ecr.eu-central-1.amazonaws.com/eaas_module_handler:v2.1
eaas_web_image string Image name with the tag for a web container 762216258500.dkr.ecr.eu-central-1.amazonaws.com/eaas-web:v2.1
eaas_api_image string Image name with the tag for an API container 762216258500.dkr.ecr.eu-central-1.amazonaws.com/eaas-api:v2.1
mongo_image string Image name with the tag for a mongo container mongo:3
rabbit_image string Image name with the tag for a rabbit container rabbitmq
eaas_docker_hub_org string Allows you to use a docker hub registry in the EaaS chart "hub"
eaasSecret.aws_access_key string AWS access key “”
eaasSecret.aws_secret_key string AWS access key “”
eaasSecret.aws_region string AWS region "eu-central-1"
kubeconf apiVersion: v1
clusters:
- cluster:
certificate-authority-data: <ca data>
server: <k8s API endpoint>
ame: cluster
contexts:
- context:
cluster: cluster
user: user
name: context
current-context: context
kind: ""
users:
- name: user
user:
token: some_k8s_token
mongo_storage_size string A parameter needed to set the size of the MongoDB storage 2Gi
nodeSelector map Kubernetes pods parameters
beta.kubernetes.io/os string OS type linux

# Step 4

Run the following command:

helm install --namespace demoinstall --set name=eaas --values ./eaas/values.yaml ./eaas

️❗️ WARNING

Even though the applications can be installed in different namespaces, the application names should be unique. Otherwise, the command above fails.

# Step 5

The application is being warmed up (this may take approximately two minutes). Once done, copy the value of the Hostname parameter–specified in the yaml.file and paste it into the browser. Then press Enter on your keyboard.

# Step 6

On the page that appears, enter the credentials provided by the KENV organization and click Login locally. Alternatively, click the Login with GitLab button to log into the EaaS application using your GitLab account.

KENV EaaS

💡 TIP

In addition, the following options are available to you:

  • Privacy Policy: click the link button to open the Website Privacy Policy page and read how your personal data is used by KENV.
  • Terms and Conditions: click the link button to open the Website Terms of Use page and read a set of regulations you must agree to in order to use EaaS.
  • KENV: click the logo to open the KENV homepage.
  • License Agreement: click the link button to open the License Agreement page and read how the EaaS product can be used and what happens in the event of a breach.
  • Cookie Policy: click the link button to open the Cookie Policy page and read how cookies are stored and accessed from your device when you use EaaS.

# Step 7

On the welcome page of the wizard, click Get Started.

KENV EaaS

💡 TIP

By default, the Don’t show me again check box is cleared. Select it in case you do not want to have the wizard displayed each time you log into the EaaS application.

# Step 8

In the dialog box that appears, under the EaaS Credentials tab, fill in the following fields: KENV EaaS

💡 TIP

In case of an on-premise installation of the EaaS product, the following credentials are automatically provided and displayed:

  • Username: kenv
  • Email: eaasadmin@kenv.io
  • Password: kenvpass

In case of the SaaS installation, under the EaaS Credentials tab, you must provide the credentials on your own.

  • EaaS Admin Profile block:
    • Username (mandatory): enter/update a username to log into the EaaS application.
    • Fullname: enter your full name.
    • Email (mandatory): enter/update your email address.
  • EaaS Admin Password block:
    • Current password: enter your current password.
    • New password: enter a new password you want to use to log into the EaaS application.
    • Confirm new password: enter a new password again.

# Step 9

Once the necessary fields are filled in, click Next. Alternatively, click the Skip button and fill in these fields later on.

# Step 10

Under the License tab that opens, a current license status is displayed: NO LICENSE KEY.

KENV EaaS

Click the Upgrade License button to set the license. Then, in the License Upgrade dialog box that appears, enter the EaaS license key provided by the KENV organization and click Apply License Key.

# Step 11

Now, do one of the following:

  • Click Next to proceed further.
  • Click Skip and set the license later on. However, be aware that you will not be able to create environments without the license.
  • Click Back and get redirected to the page back where you can reenter some data.

# Step 12

Under the Docker Registry Configuration tab that opens, click the Add repository button and set up a docker registry that you want to use when creating new environments in EaaS.

KENV EaaS

In the Add repository dialog box that appears, fill in the following fields:

KENV EaaS
  • Alias: enter the repository alias (for example, “AWS ECR”).
  • URL: enter the URL to access a repository in the registry (for example, “https://762216258500.dkr.ecr.eu-central-1.amazonaws.com”).
  • Use token auth: select the check box in case an authorization token must be used to access the registry. In the text field that appears, enter the authorization token.
  • Username (not available if the Use token auth check box is selected): enter a username to access a repository (for example, “AWS”).
  • Password (not available if the Use token auth check box is selected): enter a password to access a repository.
  • Use as source for modules: by default, the check box is selected, meaning that the repository will be used as a source for EaaS plugins.

# Step 13

Click Save.

💡 TIP

  • To edit the repository parameters (e.g., a username, password, alias, etc.), in the Docker Registry repositories grid, simply double-click the needed repository record. In the Edit repository dialog box that appears, update the needed fields and click Save.
  • To remove the unnecessary repository from the Docker Registry repositories grid, click the Remove icon KENV EaaS next to it.

# Step 14

Once the docker registry is set up, do on of the following:

  • Click Next to proceed further.
  • Click Skip and set up the docker registry later on.
  • Click Back and get redirected to the page back where you can reenter some data.

# Step 15

Under the Email Provider tab that opens, fill in the following fields to configure an SMTP server used by EaaS to send email notifications on environment updates, states of the scheduled tasks, license statuses, etc.

KENV EaaS
  • SMTP server configuration block:
    • Use secure connection: by default, the check box is cleared, meaning that an SMTP email transfer does not provide an encryption. If you want to make your connection more secure, select the check box, respectively.
    • Host: enter the URL or IP address of the SMTP server you need.
    • Port: usually, SMTP employs port 25. However, some IPs deny it because of the massive spam or malware traffic. In this case, it is recommended to use port 587 or port 465 instead.
    • Auth Method: expand the drop-down list box and select the authentication method of your choice:
      • Basic: select it in case an SMTP server requests you to authorize using the username and password.
      • NTLM: select it in case a challenge-response authentication mechanism is preferred.
    • Username: enter your email address.
    • Password: enter a password to authenticate the email address specified above.
    • Default FROM: enter an email address that you want to use for outbound emails.
    • Default ReplyTo: enter an email address where any replies to your email are to be sent.
  • Configuration test block:
    • Enter email address: enter an email address that is used by the system to verify if the SMTP settings are valid. Then, click the Send Email button and check the mailbox for the test account.

# Step 16

Now, once the SMTP server is configured, do on of the following:

  • Click Next to proceed further.
  • Click Skip and set up the SMTP server later on.
  • Click Back and get redirected to the page back where you can update some docker registry configurations.

# Step 17

Under the Summary tab that opens, do one of the following:

KENV EaaS
  • Click Create Environment to start creating new environments.
  • Click Back and get redirected to the page back where you can update some SMTP settings.
  • Click Finish to close the wizard. The EaaS homepage opens.

The EaaS product has now been installed.