GO REST App

This guide deploys a Golang REST application to ComputeSphere.

info

We use a pre-built ComputeSphere container image in this guide.

Prerequisites

• A ComputeSphere account.
• Docker and Docker registry repository - If using your own Docker image.
• ComputeSphere API Token - Follow the steps here to get your account API token.

Step 1: Setting Up the Project

Use a Pre-built Image

You can use our pre-built Docker image on the ComputeSphere registry. Here's the image tag that we'll use.

quay.io/computesphere/computesphere-golang-rest-api-example:latest

Use Your Docker Image

These steps guide you in creating an image based on our project example.

1. Clone the project example:

git clone https://github.com/computesphere-samples/computesphere-golang-rest-api-example.git

2. Create the Docker image:

docker build -t computesphere-golang-rest-api-example:v0.0.1 .

3. Tag and Push the Docker image:

docker tag computesphere-golang-rest-api-example:v0.0.1 [REPOSITORY]/computesphere-golang-rest-api-example:v0.0.1

docker push [REPOSITORY]/computesphere-golang-rest-api-example:v0.0.1

info

Replace [REPOSITORY] with the name of your image registry repository.

Step 2: Create a Project

1. Login to your ComputeSphere console → click on New Project.

2. Provide a name for the project, then click Create.

Step 3: Create a new service

1. Inside your project page, click New Service.

2. Click New App Service.

3. Click Deploy Image.

Step 4: Configure and Deploy the Service

1. Provide a name for the service and click Next.

2. In the dropdown, click Create New Environment. In this section, you can add application environment variables, such as General Variables or Secret Variables. The variables are key-value pairs.

info

For more information regarding Environment, please see here.

3. Provide the name and the region for the environment → click Create → click Next.

4. Put the ComputeSphere pre-built image link: quay.io/computesphere/computesphere-golang-rest-api-example:latest.

info

If you have your own docker container image, change the URL to your image URL.

5. Select the number of Spherelets to allocate. In this example, we're going to use 4 Spherelets.

6. You can choose to add storage to your service. In this example, we won't use one.

7. You can enable health checks by setting the configurations. For this example, we'll keep the default settings.

info

For more information regarding Health Checks, please see here.

8. Specify the port  → click Deploy. For this example, we use the 8000 port. Select the Public Access for network access.

info

For more information regarding Networking, please see here.

9. Wait for the deployment to finish → new screen appears with details about your deployed application. Click Open Website.

10. If you see the following page, your deployment was successful.

11. Append /ping to the URL to see the response from the Go application.

Step 5: Accessing the API

info

Replace [BASE_URL] with the URL of your deployed application.

1. Create an article:

curl -L 'https://[BASE_URL]/api/v1/articles' \
-H 'Content-Type: application/json' \
-d '{
    "title": "First article",
    "desc": "My first article in Golang application",
    "content": "Here goes my extraordinary story....",
    "coverImageUrl": "https://some.url/images/adsflkj4"
}'

2. Get all articles:

curl -L 'http://localhost:8000/api/v1/articles'

3. Retrieve a specific article:

curl -L 'https://[BASE_URL]/api/v1/articles/1'

4. Update an article:

curl -L -X PUT 'https://[BASE_URL]/api/v1/articles/1' \
-H 'Content-Type: application/json' \
-d '{
    "id": 1,
    "title": "First article - updated",
    "desc": "My first article in Golang application",
    "content": "Here goes my extraordinary story....",
    "coverImageUrl": "https://some.url/images/adsflkj4"
}'

5. Delete an article:

curl -L -X DELETE 'https://[BASE_URL]/api/v1/articles/1'

That's it. Now, you have successfully deployed your application to ComputeSphere.