Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Deployment on artifakt #13723

Merged
merged 1 commit into from
Mar 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions docs/cookbook/deployment/artifakt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
How to deploy Sylius to Artifakt.com
====================================

1. What is Artifakt?
--------------------

`Artifakt <https://www.artifakt.com/>`_ is an all-in-one platform helping enterprises and developers fast-track deployments,
manage and run complex web applications on enterprise-grade cloud infrastructures on a global scale.

2. How does Artifakt work?
--------------------------

Artifakt provides a service based on Cloud technologies to help build, deploy, monitor, secure, and manage the scalability of your applications.

3. Create an Artifakt project
-----------------------------

To get off to a good start with Artifakt, you first need to create a project.
AdamKasp marked this conversation as resolved.
Show resolved Hide resolved

Click Create Project in the left menu and follow the steps to create your first project.
The project code must be unique within the workspace, you can refer to projects for more information.

.. image:: /_images/cookbook/deployment/artifakt/create_project.png
:scale: 55%
:align: center

In the second step, select the Sylius runtime and version that corresponds to the application you want to deploy.
Also, choose the `region <https://docs.artifakt.com/platform/available-regions>`_ where your application and data will be deployed.
When you create a project, you can use the default Artifakt code base for the chosen Sylius runtime, or you can link your own Git repository.
If you wish to use the Artifakt default code base, simply click "Skip, and Create Project". Otherwise, you can choose the location of your repository and choose your preferred repository and default branch.
If you did not link your Git repository during the project creation, you can do so afterwards by going to `Project → Settings → Environments` and clicking Link to a different repository so that you can then create environments using your application's source code.

.. image:: /_images/cookbook/deployment/artifakt/github_settings.png
:scale: 55%
:align: center

.. hint::

If you don't have an account on **Artifakt.com**, you should request a demo or contact support first.

4. Create an environment
------------------------

Once the project is created, you can create your first environment. To do so, go to your project and click on **New Environment**.
When creating an environment, you must define a name, the Git branch to deploy, the `type of platform <https://docs.artifakt.com/platform/platform-management>`_ to use, and the `criticality <https://docs.artifakt.com/platform/environment-lifecycle#environnement-et-criticite>`_ (environments can be either `critical` or `noncritical`).

.. image:: /_images/cookbook/deployment/artifakt/create_environment.png
:scale: 55%
:align: center

If you set up your Git repository at the project level, the branches associated with your repository are automatically retrieved and available in the drop-down list.

5. Building the environment
---------------------------

Once your environment has been created, you can now launch its construction by clicking on **Build** in the drop-down menu.
You will then be redirected to the Overview page of the environment, from where you can follow the creation and start up of each service of the platform, in real time.

.. image:: /_images/cookbook/deployment/artifakt/build.png
:scale: 55%
:align: center

Once the environment is deployed and available online, a domain name generated by Artifakt will be displayed in the list of project environments and on the environment home page.

.. image:: /_images/cookbook/deployment/artifakt/domain_name.png
:scale: 55%
:align: center

An Artifakt page will indicate that your environment's infrastructure has been created. You will then have to deploy your application source code when you are ready.

.. image:: /_images/cookbook/deployment/artifakt/deploy.png
:scale: 55%
:align: center


Bravo! 🥳 💯 Your application is online thanks to Artifakt!
1 change: 1 addition & 0 deletions docs/cookbook/deployment/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
* :doc:`/cookbook/deployment/cloudways`
* :doc:`/cookbook/deployment/cron-jobs`
* :doc:`/cookbook/deployment/symfonycloud`
* :doc:`/cookbook/deployment/artifakt`
1 change: 1 addition & 0 deletions docs/cookbook/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ Deployment
deployment/platform-sh
deployment/cloudways
deployment/cron-jobs
deployment/artifakt

.. include:: /cookbook/deployment/map.rst.inc

Expand Down