Commit 111d9616 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis Committed by Ruben Davila

Merge branch 'docs-koding-change-loc' into 'master'

Split Koding admin/user docs

Backend/Frontend MR

See merge request !5938
parent 6aefd8f3
......@@ -3,7 +3,7 @@ class KodingController < ApplicationController
layout 'koding'
def index
path = File.join(Rails.root, 'doc/integration/')
path = File.join(Rails.root, 'doc/user/project/')
@markdown =
......@@ -405,7 +405,7 @@
%strong gitlab
team, and you need to provide that team's URL here. Learn more in the
= succeed "." do
= link_to "Koding integration documentation", help_page_path("integration/koding")
= link_to "Koding administration documentation", help_page_path("administration/integration/koding")
......@@ -4,6 +4,3 @@
Integration is active for
= link_to koding_project_url, target: '_blank' do
= markdown @markdown
......@@ -18,6 +18,7 @@
- [SSH](ssh/ Setup your ssh keys and deploy keys for secure access to your projects.
- [Webhooks](web_hooks/ Let GitLab notify you when new code has been pushed to your project.
- [Workflow](workflow/ Using GitLab functionality and importing projects from GitHub and SVN.
- [Koding](user/project/ Learn how to use Koding, the online IDE.
## Administrator documentation
......@@ -29,6 +30,7 @@
- [Restart GitLab](administration/ Learn how to restart GitLab and its components.
- [Integration](integration/ How to integrate with systems such as JIRA, Redmine, Twitter.
- [Issue closing](customization/ Customize how to close an issue from commit messages.
- [Koding](administration/integration/ Set up Koding to use with GitLab.
- [Libravatar](customization/ Use Libravatar for user avatars.
- [Log system](administration/ Log system.
- [Environment Variables](administration/ to configure GitLab.
# Koding & GitLab
> [Introduced][ce-5909] in GitLab 8.11.
This document will guide you through installing and configuring Koding with
......@@ -12,10 +14,9 @@ provisioned VMs. This agent is called Klient and it provides Koding to access
and manage the target machine.
Kontrol and Klient are based on another technology called
[Kite](, that we have written at Koding. Which is a
[Kite](, that we have written at Koding. Which is a
microservice framework that allows you to develop microservices easily.
## Requirements
### Hardware
......@@ -31,20 +32,20 @@ least a `c3.xlarge` instance.
### Software
- [git](
- [docker](
- [Git](
- [Docker](
- [docker-compose](
Koding can run on most of the UNIX based operating systems, since it's shipped
as containerized with Docker support, it can work on any operating system that
supports Docker.
Required services are;
Required services are:
- PostgreSQL # Kontrol and Service DB provider
- MongoDB # Main DB provider the application
- Redis # In memory DB used by both application and services
- RabbitMQ # Message Queue for both application and services
- **PostgreSQL** - Kontrol and Service DB provider
- **MongoDB** - Main DB provider the application
- **Redis** - In memory DB used by both application and services
- **RabbitMQ** - Message Queue for both application and services
which are also provided as a Docker container by Koding.
......@@ -237,3 +238,5 @@ login) once you accept you will be redirected to your Koding instance.
From now on you can login by using `SIGN IN WITH GITLAB` button on your Login
screen in your Koding instance.
# Koding & GitLab
> [Introduced][ce-5909] in GitLab 8.11.
This document will guide you through using Koding integration on GitLab in
detail. For configuring and installing please follow [this]( guide.
detail. For configuring and installing please follow the
[administrator guide](../../administration/integration/
You can use Koding integration to run and develop your projects on GitLab. This
will allow you and the users to test your project without leaving the browser.
......@@ -10,29 +13,26 @@ environment for your project. With this integration you can automatically
create a proper stack template for your projects. Currently auto-generated
stack templates are designed to work with AWS which requires a valid AWS
credential to be able to use these stacks. You can find more information about
stacks and the other providers that you can use on Koding from
stacks and the other providers that you can use on Koding following the
[Koding documentation][koding-docs].
# Enable Integration
## Enable Integration
You can enable Koding integration by providing the running Koding instance URL
in Application Settings;
in Application Settings under **Admin area > Settings** (`/admin/application_settings`).
- Open **Admin area > Settings** (`/admin/application_settings`).
![Enable Koding](help/integration/img/koding_enable-koding.png)
![Enable Koding](img/koding_enable-koding.png)
Once enabled you will see `Koding` link on your sidebar which leads you to
Koding Landing page
Koding Landing page.
![Koding Landing](help/integration/img/koding_landing.png)
![Koding Landing](img/koding_landing.png)
You can navigate to running Koding instance from here. For more information and
details about configuring integration please follow [this]( guide.
details about configuring the integration, please follow the
[administrator guide](../../administration/integration/
# Set up Koding on Projects
## Set up Koding on Projects
Once it's enabled, you will see some integration buttons on Project pages,
Merge Requests etc. To get started working on a specific project you first need
......@@ -40,83 +40,89 @@ to create a `.koding.yml` file under your project root. You can easily do that
by using `Set Up Koding` button which will be visible on every project's
landing page;
![Set Up Koding](help/integration/img/koding_set-up-ide.png)
![Set Up Koding](img/koding_set-up-ide.png)
Once you click this will open a New File page on GitLab with auto-generated
`.koding.yml` content based on your server and repository configuration.
![Commit .koding.yml](help/integration/img/koding_commit-koding.yml.png)
![Commit .koding.yml](img/koding_commit-koding.yml.png)
# Run a project on Koding
## Run a project on Koding
If there is `.koding.yml` exists in your project root, you will see
`Run in IDE (Koding)` button in your project landing page. You can initiate the
process from here.
![Run on Koding](help/integration/img/koding_run-in-ide.png)
![Run on Koding](img/koding_run-in-ide.png)
This will open Koding defined in the settings in a new window and will start
importing the project's stack file;
importing the project's stack file.
![Import Stack](help/integration/img/koding_stack-import.png)
![Import Stack](img/koding_stack-import.png)
You should see the details of your repository imported into your Koding
instance. Once it's completed it will lead you to the Stack Editor and from
there you can start using your new stack integrated with your project on your
GitLab instance. For details about what's next you can follow
[this]( guide from 8. step.
[this guide]( from step 8.
Once stack initialized you will see the `` content from your project
in `Stack Build` wizard, this wizard will let you to build the stack and import
your project into it. **Once it's completed it will automatically open the
related vm instead of importing from scratch**
related vm instead of importing from scratch**.
![Stack Building](help/integration/img/koding_start-build.png)
![Stack Building](img/koding_start-build.png)
This will take time depending on the required environment.
![Stack Building in Progress](help/integration/img/koding_build-in-progress.png)
![Stack Building in Progress](img/koding_build-in-progress.png)
It usually takes ~4 min. to make it ready with a `t2.nano` instance on given
AWS region. (`t2.nano` is default vm type on auto-generated stack template
which can be manually changed)
which can be manually changed).
![Stack Building Success](help/integration/img/koding_build-success.png)
![Stack Building Success](img/koding_build-success.png)
You can check out the `Build Logs` from this success modal as well;
You can check out the `Build Logs` from this success modal as well.
![Stack Build Logs](help/integration/img/koding_build-logs.png)
![Stack Build Logs](img/koding_build-logs.png)
You can now `Start Coding`!
![Edit On IDE](help/integration/img/koding_edit-on-ide.png)
![Edit On IDE](img/koding_edit-on-ide.png)
# Try a Merge Request on IDE
## Try a Merge Request on IDE
It's also possible to try a change on IDE before merging it. This flow only
enabled if the target project has `.koding.yml` in it's target branch. You
should see the alternative version of `Run in IDE (Koding)` button in merge
request pages as well;
![Run in IDE on MR](help/integration/img/koding_run-mr-in-ide.png)
![Run in IDE on MR](img/koding_run-mr-in-ide.png)
This will again take you to Koding with proper arguments passed, which will
allow Koding to modify the stack template provided by target branch. You can
see the difference;
![Different Branch for MR](help/integration/img/koding_different-stack-on-mr-try.png)
![Different Branch for MR](img/koding_different-stack-on-mr-try.png)
The flow for the branch stack is also same with the regular project flow.
# Open GitLab from Koding
## Open GitLab from Koding
Since stacks generated with import flow defined in previous steps, they have
information about the repository they are belonging to. By using this
information you can access to related GitLab page from stacks on your sidebar
on Koding.
![Open GitLab from Koding](help/integration/img/koding_open-gitlab-from-koding.png)
![Open GitLab from Koding](img/koding_open-gitlab-from-koding.png)
## Other links
- [YouTube video on GitLab + Koding workflow][youtube]
- [Koding documentation][koding-docs]
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment