Yelken Docs

Appearance

Project ​

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

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 ​

You can create either an empty project or a project with a service. The later one allows you to setup a project and a service quickly. To start creating a new project:

  1. Go to Create Project page. You can also access it in the Projects page by using Create Project button.

  2. If you want to create an empty project, choose Empty Project item from the options.

    Otherwise, choose any other options to create an appropriate service too. To learn more about other options, please checkout Service documentation.

  3. Lastly, give a name to your project and use Create button to create the project.

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. If you chose the Empty Project, the list would be empty.

Managing Project ​

Inside a project, you can:

  • Create services and environments,
  • Manage domains with their associated routes,
  • Create workflows and pipelines that automate build and deployment of your services,
  • Add private container registries which will be used later for fetching services' container images from external private registries.

To learn more about how to manage resources that belong to a project, please read the respective resource's documentation page. For example, to learn how to manage a service, you can look at Service page.

Project Settings ​

To view the project's settings:

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

Project settings page has many subpages 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!