Project

Project allows you to group a collection of resources together on the Yelken platform. These resources are:

• Service
• Environment
• Domain
• Private Container Registry

In addition to these resources, a project consists of a few properties that define it:

• Name. This is only used for display purposes.
• Key. A project's key is unique across all projects in Yelken platform and helps giving a unique name to resources located under itself.

You can view your projects in Yelken Dashboard by going into Projects page. If you do not have any projects yet, you can create a new one by using Create Project button located in the same page.

Creating Project

Once you are in Create Project page, you need to provide a few information:

1. Name: specify a name for your project. You can change it later under the Project Settings page.
2. Project Template: decide to create a Web Application or an Empty Project by selecting corresponding option. Choosing a web app makes it easy to setup a project with a web app and quickly create your own website. You can also add them after you create the project.
3. Web Application (optional): if you choose to create a web app too, there are multiple Applications for you to pick.
4. Plan (optional): choose an appropriate plan for the web app according to your needs.

While a project is being created, Yelken will also create an environment called Production inside the project. Once you create project, you will be redirected to Services page where you can see list of services that exist in this environment.

Managing Project

Inside a project resource, you can create services and environments, manage domains with their associated routes and add private container registries which will be used later for fetching services' container images.

Services

To view list of services that belong to an environment:

• Open a project by choosing it in Projects page,
• Use Services link accessible inside the sidebar located at left.
• Additionally, change selected Environment displayed at the top bar to view services in different environment.

In this page, you can view all services that belong to the environment chosen at the top bar. You can also:

• Create a new service,
• Clone a service by opening dropdown menu located at the end of the service's name,
• View details of a service.

For more information about Service resource, please look at Service's documentation.

Environments

To view list of environments inside of a project:

• Open a project by choosing it in Projects page,
• Use Environments link accessible inside the sidebar located at left.

In this page, you can view a list of environments in a table format. You can also either view details of an environment or create a new one. For more information about creating environment, please look at Environment's documentation.

Network Settings

To view your own domains attached to a project:

• Open a project by choosing it in Projects page,
• Use Domains & Routes link accessible inside the sidebar located at left.

Project's network settings allow you to add your own domains and configure how they will be used for accessing your services located inside the project's environments. This topic is covered under Networking > Domains & Routes part of the documentation.

Project Settings

To view the project's settings:

• Open a project by choosing it in Projects page,
• Use Project Settings link accessible inside the sidebar located at left.

Project settings page has many subpagse to make it easy to use. One of them is Container Registries where you can manage your container registries and enable Yelken to fetch images located inside private registries. For more information about managing them, please look at Private Container Registry's documentation.

Another subpage is the Settings where you can update the name of your project. There is also a Danger Zone section where you can perform dangerous operation on your project.

Deleting Project

Inside the project's settings, under the Danger Zone section, you can use Delete Project button to delete your project. It will require a confirmation from you by asking you to enter the name of project and its key.

⚠️ Please be careful

All resources belonging to the project will be deleted immediately once you confirm the deletion. There is no going back after confirming the deletion!