Appearance
Quick Start with Yelken Cloud
Before getting started, you need to create a Yelken account and have access to Yelken Cloud dashboard.
INFO
You may need to verify your account if you sign up with your email address.
Once you reach to Yelken dashboard, there are two possible ways for you to start quickly with Yelken: either deploy a managed web application such as WordPress or your own containerized workload.
Deploying WordPress
Yelken provides a managed web app experience for WordPress without requiring you to handle configuration and installation. You can simply create a WordPress website by creating a new project in Create Project page.
While creating project, you need to:
- Specify a Name for your project,
- Choose
Web Applicationfor Project Template option, - Choose
WordPressas the Web Application option, - Pick a suitable Plan for your needs,
- Finally, use the Create button to create the project.
Once you create the project, you will be redirected to services page where you can see your WordPress service with Creating state. This state means that Yelken is creating necessary resources for service to start running. Under one minute, the service should switch to Running state and you can access it with the URL displayed under network column.
Additionally, if you want to add a WordPress service to an already existing project, you can do so by using Create Service button located inside the services page. To learn more about managed Wordpress experience, you can read documentation of Yelken's WordPress service.
You can now either continue with learning about deploying your own containerized workload or read basic concepts of Yelken as a platform.
Deploying a Containerized Workload
You can run your containerized workloads on Yelken platform by creating a Custom Service. With custom service, Yelken allows you to:
- Run a container image,
- Specify variables and secrets to either pass them to your application at runtime through environment variables or mount them into filesystem to let your application read,
- Create volumes and mount them into container's filesystem to have a persistent storage,
- Configure network settings of your application by specifying ports it listens to enable both internal and external connections.
Container image compatibility
Currently, Yelken only supports OCI container images that are compatible with x86_64 architecture. It is planned for the future to expand this compatiblity to images with arm64 architecture.
To create a custom service, you can either create a service in an existing project or create an empty project in Create Project page. While creating an empty project, you need to:
- Specify a Name for your project,
- Choose
Empty Projectfor Project Template option, - Finally, use the Create button to create the project.
Once you have a project and navigated to services page, you can use Create Service button to start creating a service. While creating a service, you need to:
- Specify a Name for your service,
- Choose
Customfor Service Template option, - Pick a suitable Plan for your needs,
- Specify Image for your container.
For images stored on Docker Hub, you can simply specify image name and tag, such as nginx:stable. For images stored on other registries, you need to specify full URL of the image.
- Optionally, specify Variables and Secrets to pass to your container as environment variables,
- Optionally, specify Volumes and their Mount Points,
- Finally, use the Create button to create the service.
Images stored in private registries.
If you want to use an image stored inside an internet accessible private registry, you need to add a Container Registry under Project's Settings with correct credentials to let Yelken access your private registry during container startup.
After adding Container Registry, you can choose it to use for the image while creating the service.
Your credentials are securely stored in Yelken infrastructure by encrypting them at rest.
When you create the service successfully, you will be redirected to services page where you can see your new service with Creating state. This state means that Yelken is creating necessary resources for service to start running. Depending on the image size and available resources on Yelken, it can take one or two minutes for service to switch to Running state. If an error occurs during container startup, such as image pull failures or application crashes, state of service will show an error.
Next Step
Deploying a managed web application or a custom service enables you to have a quick start with Yelken. From there, you can continue with learning concepts and features about Yelken platform such as observability for inspecting service logs and metrics, networking to add your own domains and access your services from internet, workspace features for working collaboratively with your team.
To start with and learn basic concepts of Yelken, you can read the Basic Concepts page.