Skip to content

Commit

Permalink
Merge pull request #7 from skyu-io/feat/add-code-to-k8s-deployment-tu…
Browse files Browse the repository at this point in the history
…torial

Feature Add Content to source code to k8s deployment app creation tutorial
  • Loading branch information
nilesh93Insighture authored Apr 5, 2024
2 parents 4c81480 + fab1220 commit 2615ea6
Show file tree
Hide file tree
Showing 17 changed files with 117 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/Tutorials/applications/source-code-kubernetes-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,60 @@
title: Source Code to Kubernetes Deployment
---

# Getting Started

This application type is able to take your source code —particularly those designed as `Microservices` or `APIs`, and those involving long-running background tasks— and deploying it as a set of scalable, manageable services within a Kubernetes environment.

## 01 - Select Application

Select `Source Code to Kubernetes Deployment` application type from the catalogue.

![](/assets/images/tutorials/app-creation/source-code-kubernetes-deployment/select-application.png)

## 02 - Fill General Details

Provide a name (Required) and a small description (Optional) of the appliction.

![](/assets/images/tutorials/app-creation/source-code-kubernetes-deployment/step1-general-details.png)

## 03 - Link Application Repository

Link your repository which holds the application code.

![](/assets/images/tutorials/app-creation/source-code-kubernetes-deployment/step2-link-repo.png)

## 04 - Configure Pipeline Triggers

You can configure the triggers per environment in this step defining the `branches/tags` in which the workflows are going to be Triggered. These will be prefilled with the standard conventions which you can override.

![](/assets/images/tutorials/app-creation/source-code-kubernetes-deployment/step3-add-triggers.png)

## 05 - Configure the Build Pipeline

You can use this step to configure the build pipeline.

- **`Trigger Path`** - This `optional` setting allows you to specify a file or folder path. Any changes to the selected path will automatically trigger the pipeline.

- **`Dockerfile Path`** - Define the relative path from the project root to the `Dockerfile`. This path is necessary for the pipeline to locate your Dockerfile.

- **`Dockerfile Build Context`** - Select the directory that contains the Dockerfile. This directory serves as the build context for Docker.

- **`List Integrations`** - Choose a registry resource (e.g., Docker Hub, Amazon ECR, etc.) to store the built image using the SkyU service. Additional details on how to add these credentials are provided below.

- **`Image Repository Name`** - Specify the repository name (e.g., docker.io/<username\>/note-app) where the built image will be stored.

![](/assets/images/tutorials/app-creation/source-code-kubernetes-deployment/step4-build-pipeline.png)

By selecting the "Create New Credential" option, you can link a registry resource to save the built image via the pipeline service offered by SkyU. For a complete guide on linking Image Registries, visit the [Create Image Registry tutorial](../image-registry/docker-registry.md).

## 06 - Add Service Ports

In this step, you will add the service ports. Additionally, if your application includes a Swagger specification for API documentation, you should also provide the path to the swagger.json file. This configuration can be adjusted later if necessary.

![](/assets/images/tutorials/app-creation/source-code-kubernetes-deployment/step5-service-ports.png)

Finally create the Application.

## 06 - View Application

A new `Services` application will now be listed under your project applications.
30 changes: 30 additions & 0 deletions docs/Tutorials/image-registry/amazon-ecr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Creating Amazon Elastic Container Registry
---

# Getting Started

To initiate linking Docker integrations with your project, first, select a project within your organization.

![](/assets/images/tutorials/image-registry/amazon-ecr/registry-list.png)

Click on `+ Integration` to introduce a new Amazon Elastic Container Registry credential into your project.

## 01 - Add Credential

When linking a Amazon Elastic Container Registry resource, you are required to provide the following details:

![](/assets/images/tutorials/image-registry/amazon-ecr/add-amazon-ecr.png)

Make sure you click the `Create Role on AWS` button to actually create the role on AWS. (You will be redirected to do this)

> **NOTE**<br/>
> Make sure you are logged into your AWS account's console in a different tab in th same browser as the SkyU console before clicking the `Create Role on AWS` button.
![](/assets/images/tutorials/image-registry/amazon-ecr/create-stack.png)

Fill the `GithubOrgName` with your Github organization name. As an example, if your repo is in a personal account, the repo URL would be something like `https://github.com/git-username/repo-name`. In which case the `GithubOrgName` would be 'git-username'.

## 02 - Edit Credential

Any Amazon Elastic Container Registry credential you've added can be modified later through the image registries list page.
28 changes: 28 additions & 0 deletions docs/Tutorials/image-registry/docker-registry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Creating Docker Image Registry
---

# Getting Started

To initiate linking Docker integrations with your project, first, select a project within your organization. Navigate to `Settings` -> `Integrations` ->` mage Registries` to view all existing image registry credentials.

![](/assets/images/tutorials/image-registry/docker-registry/selection.png)

Click on `+ Integration` to introduce a new Docker Image Registry credential into your project.

## 01 - Add Credential

When linking a Docker Image Registry resource, you are required to provide the following details:

![](/assets/images/tutorials/image-registry/docker-registry/add-docker-cred.png)

> NOTE<br/>
> For the Registry URL, adhere to the format docker.io/username, where username is the username associated with your Docker account. Ensure `not` to append a `/` at the end of the URL.
Finally select `Create` button to save the credential.

## 02 - Edit Credential

Any Docker Image Registry credential you've added can be modified later through the image registries list page.

![](/assets/images/tutorials/image-registry/docker-registry/edit-docker-cred.png)
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ nav:
- Tutorials/applications/source-code-kubernetes-deployment.md
- Tutorials/applications/docker-compose-jobs-on-ec2.md
- Tutorials/applications/web-application-on-aws-cloudfront.md
- Create Image Registry:
- Tutorials/image-registry/docker-registry.md
- Tutorials/image-registry/amazon-ecr.md
- API:
- API/index.md
- FAQ:
Expand Down
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2615ea6

Please sign in to comment.