Codeobe Quick Start Guide

 Getting Started  #

Visit https://codeobe.cloud to get started. If you are a new user, you must first register. You can either go to https://codeobe.cloud/register link or click on the REGISTER button.

                                                                                      Image: Codeobe Register Page

Once you fill your data and registered you will be redirected to the payments page.

                                                                                   Image: Payment page

 

Once you entered your payment details you will be directed back to codobe .

Check your emails and you should get an email verification email like below.

                                                                                       Image: User Verification Email

You have to verify your email by clicking that link.

 Image: Verification page

 

Once the email is verified, user can login to Codeobe using the login page.

 Image: Codeobe login page

 Navigating through Codeobe #

The Codeobe user interface is simple and straightforward to use. Let’s have a look at the numbered menus now.

Image: Codeobe platform dashboard

 

Image: Codeobe platform  menus

 

Menu A: This corresponds to the project’s lifecycle stages

Repos #

This is where you can see all your connected Code Repositories.

Deployables #

Build artifacts of your repositories are listed here.

Services #

Running images and its status can be found here.

Process logs #

This tab will show you the messages passed through.

Configure #

Configurations related to repos, and runtimes are listed here

Quickstart #

The Quick Start Guide, SDK, and Sample projects can be found here.

Menu B:

Configuring your Codeobe account #

To start with Codeobe, you must do some configurations first.  Go to the CONFIGURE in the top navigation bar. First, let’s look at how to configure the source repository. Codeobe supports github, BitBucket,GitLab,AzureRepos as repositories .

Image: Configure page view

Users can configure the following sections using the configuration page

Runtime – Select where you want your micro integrations to run.

  • Codeobe Free Tier: Run your integration packages on Codeobe’s run time. Note that the underlying resources are shared by all Free-Tier uses. 
  • Azure: Select this if you intend to run the packages on our own run time powered by Azure
  • GCP: Select this if you intend to run the packages on our own run time powered by GCP
  • AWS: Select this if you intend to run the packages on our own run time powered by AWS

Repository Type – Select where your repository is located at. 

  • We currently support GitHub, Bitbucket, and Azure Repos.

Domain Key: It’s auto-generated for you.

Account – The account name used to access the repository.

Token– Enter the unique Personal Access Token generated through GitHub, Bitbucket, Gitlab, or Azure Repos.

Allow Invite users – enable or disable collaboration feature for development 

Configuring Your source repo #

Github #

Github is the widely used code host or repository in the world. Codeobe supports GitHub as a first-class citizen. To configure Github, users first need to create a Github PAT (personal access token). 

Creating PAT #

You can follow this link and our documentation below to create the PAT (Personal Access Token) https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

Image : Github Token Creation Form

Image : GitHub Token Creation Success

Once you have created your token you can paste in the Configuration form and start the configurations.

Configure Github in Codeobe #

 Image: configure Codeobe to use GitHub Repos

Listing repos #

  Image: Listing GitHub repos

Bitbucket  #

Bitbucket is a Git-based source code repository hosting service where many companies use either onsite installation or cloud version of it.

Creating PAT #

 Image: Bitbucket token creation page

Follow six steps as in the above image to create the Bitbucket token.

  1. Log into Bitbucket Server and click your avatar to open the user menu.
  2. Then select personal settings item.
  3. Then Select App passwords
  4. Then press the create password button.
  5. Next provide the required permissions 
  6. Finally press the create button to create the token.

 

Once the token is successfully created you can view it as in the below image

 Image: Bitbucket token creation success

Once you have created your token you can paste into the Configuration form and start the configurations.

Configure BitBucket in Codeobe #

Image : Configure Codeobe to use BitBucket Repos

Listing repos #

Image  : Listing Bitbucket Repos

 

Gitlab #

GitLab is a complete DevOps platform that brings development, operations, and security teams into a single application.

Creating PAT #

Image:Gitlab token creation form

Follow the steps as in the above image.

  1. In the top-right corner, select your avatar and go to preferences.
  2. On the left side bars select Access Tokens.
  3. Then provide necessary permissions.
  4. Then create the personal access token.

Once the token is successfully created you can view as below and copy your token.

Image: Gitlab Token creation success.

Once you have created your token you can paste in the Configuration form and start the configurations.

Configure GitLab in Codeobe #

Image : Configure codeobe to use Gitlab

Listing repos #

 Image : Listing GitLab Repos

Azure repos #

Azure Repos is a set of version control tools which comes under Azure cloud.

Creating PAT #

Please follow below link to create a Personal Access Token

https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page

Image : Azure Repos

Configure Azure repos in Codeobe #

 Image : Configure Azure Devops repos on Codeobe

Once configured, Azure repos is listed on our platform. The Image below shows codeobe Repos view.

Listing repos #

Image : Codeobe repos view, list down the configured repos

Deploying your first integration flow #

You may begin with codeobe users can start with QuickStart examples to write their first micro-integration process.

Download a sample project and upload it into your source repository. And then click on ‘Repos’ in the navbar. It will list all your files in the repository as below.

As within the above image all your repos are indexed right here, you can view, view the last modification or you may be able to download by clicking the links available. You can press the CREATE PACKAGE green colored button and it will create the deployable for you. You can view your deployables under the deployables tab.

Click on the deploy button to deploy the image to the cluster. If you click on the Services tab, you will be able to see all the running deployables, with basic info on its version, uptime and url.

Monitoring your deployments #

Goto services tab and click on the service url. It will open up the swagger-ui so that you can try out your service.

Once you invoke your deployed services, you can view the application logs under the PROCESS LOGS tab.

A filtering tool is also included with the Process logs. To see the filters, click the drop-down arrow to the right of the top panel. To filter out the logs, click the refresh button after filling up the filtering information.

To view the detailed information of the messages, Click on the link with the data in the left hand side of the tabe. It will redirect you to the details process logs page. In this view the SOURCE message is denoted by S and TARGET message is denoted by T.

The source (S) message and Target (T) Message

 

If you want to see the logs in a RCA situation , users can view the server logs using the server logs feature

Error handling with Codeobe #

Suppose a scenario that one of the servers you integrated is out of service. In such situation we have adoption to resend the messages once the server is back online

 

Powered by BetterDocs