The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Getting Started with Shipa

Shipa documentation explains step-by-step procedures to utilize the various functionalities available on Shipa; however, the steps below can offer a quick start when using Shipa for the first time.

Instructions

The example below will take you through the following steps:

📘

Getting Started

The steps below assume you are accessing Shipa for the first time, and no other member in your organization has already created frameworks and bound clusters to it.

If a framework has been previously created and a cluster was bound to it, you can skip to the step that will help you deploy your first application.

Creating a framework

Frameworks are Shipa's policy engine and logical grouping of rules applied to the applications you deploy through them. They are a key component.

You can create a framework using Shipa's dashboard, using the Frameworks link.

When you click on the Create Framework button, a framework creation workflow will guide you through the different options you have to secure your applications.

Let's create a simple framework to get started

The framework name is the only field you need to enter on the first step of the workflow.

Click Next.

The second step will allow you to set policies around resource consumption rules applied to the applications you deploy through this new framework. You can select a plan available for your first sample application.

📘

Shipa Plans

If you don't see any plan available when creating your framework, you or your Shipa team administrator can create a plan using Shipa's CLI and assign it to the team you are part of.

You can find detailed information on how to create plans here.

With the plan selected, click on Next.

The access control section of the workflow will allow you to select which teams can deploy applications using your new framework.

Select one or multiple teams, and click on Next.

You can control application scalability through the application quota step. By setting the application limit, you control the number of units applications can scale up to.

This next step gives you the capability of limiting registries where application images can be pulled from. You can leave this blank for your sample framework, which means application images deployed through this framework can be pulled from any registry.

Click on Next, which will take you to the network policy setup.

You can leverage frameworks to enforce detailed network policies to applications deployed through them. For your first sample framework, you can leave both checkboxes unchecked.

By leaving both unchecked, the applications you deploy through this framework will automatically be assigned an Allow All rule for both ingress and egress.

Click on Next

The last step gives you options around security scans. Shipa has a built-in scanner that you can leverage to scan applications, images and list specific vulnerabilities that Shipa should ignore when deploying applications. Scans are run both during and post-deployment.

For your first sample framework, you can checkmark both boxes and click on Create.

Now you have the first framework that you can bind to a cluster. Let's do that in the next section of this page.

Connecting Frameworks to Clusters

Before you can deploy an application through your new framework, you should bind it to a cluster, so the framework has a target cluster bound to it where it can create the application and its objects.

You can bind clusters through the Clusters page on Shipa's framework, clicking on the Add Cluster button.

The first step in binding a cluster to frameworks will require you to enter the cluster name and the frameworks you want to bind to it. You can select the framework you created in the previous step.

📘

Cluster Name

Shipa does not require you to use the same name you have for your cluster. You can use the same or a different name that will help you identify which cluster frameworks are bound to.

Click on Next.

In the cluster connection step, you will be required to enter:

  • The cluster IP or DNS that Shipa should use to reach the cluster
  • The Shipa service account token
  • The Shipa service account certificate

📘

Shipa Service Account

You can find detailed information on how to create a service account for Shipa in your cluster and find its token and CA certificate [here] (here](https://learn.shipa.io/docs/connecting-clusters).

Once you enter the information above, click on Next.

The last step gives you the option to enter custom ingress details based on the ingress controller assigned to the framework you created in the previous step.

For your sample framework, you can leave these options blank and default. Click on Create.

After a few seconds, Shipa will be connected to your cluster and will have bound the selected frameworks. You can also check the status of the task on the Events page of your Shipa dashboard.

With your first framework created and bound to a cluster, you can now create and deploy your first application using the steps below.

Deploying a Sample Application

Deploying your sample application is divided into 2 steps:

  • Creating an application
  • Deploying the application image

You can quickly create your first application using Shipa's dashboard by going to the Applications page and clicking on the + icon.

This will open the form we should use to enter some basic application info:

  • Name: your application name
  • Framework: you should see the framework you created in the previous steps. Select it.
  • Team: select the team you want to be the owner of the application.
  • Platform: should only be used when deploying an application directly from its source code. We will deploy an existing Docker image for our sample application, so no need to set anything for the Platform.

Once created, the application will be displayed on the dashboard with an Idle status. That's because you have not yet deployed any image to it.

Now go ahead and click on the application name to enter the application details page.

Once inside the application details page, you can click on the Deploy option to deploy your sample application:

This will open the following options for you to deploy your first application:

  • Deployment type: you can use private and public registries when deploying Docker images to your applications on Shipa. For this example, select Public registry
  • Registry image: the URL of the image Shipa should use when deploying the image. For this example, enter *docker.io/shipasoftware/bulletinboard:1.0

Once you enter the information above, click on Deploy. This will start the deployment process.

📘

Deployment Progress

You can see the status and progress of your application deployment using the Events page in your Shipa dashboard

The deployment should complete in a few seconds, and once it's done, you will see the status of your sample app changing to Running.

With your application running, you can now click on the Endpoint URL and access ins your application details page, and access your application:

That's it. You have deployed your first application to Kubernetes using Shipa without learning, building, or maintaining any Kubernetes infrastructure-related manifest!

Updated 7 days ago


Getting Started with Shipa


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.