Deploying a Hello World with the OVHcloud API
Find out how to deploy a Hello World application with the OVHcloud API
Last updated 1st July, 2019.
Follow this quickstart guide to deploy a containerised Hello World application on your OVHcloud Managed Kubernetes Service cluster, using the OVHcloud API.
In this guide, we are assuming you're using the OVHcloud API to manage your Kubernetes cluster. If you are using a different method, like the OVHcloud Cloud Manager, please refer to the relevant documentation:
Before you begin
- You should have already created a cluster on the OVHcloud Managed Kubernetes service.
- You will also need the kubectl command-line tool. You can find the detailed installation instructions for this tool on Kubernetes' official site.
This guide assumes you are familiar with the OVHcloud API. If you have never used it, you can find the basics here: First steps with the OVHcloud API.
The API Explorer
To simplify things, we are using the API Explorer, which allows to explore, learn and interact with the API in an interactive way.
Log in to the API Explorer using your OVH NIC.
If you go to the Kubernetes section of the API Explorer, you will see the available endpoints:
List your OVHcloud Managed Kubernetes services
The GET /kube API endpoint lists all the available services (clusters):
By calling it, you can view a list of your services names. Note down the ID of the service (cluster) you want to use. In this example, we will refer to it as serviceName
Getting your managed cluster information
The GET /kube/{serviceName} API endpoint provides important information about your Managed Kubernetes cluster, including its status and URL.
Configuring the default settings for kubectl
Please refer to the Configuring kubectl on an OVHcloud Managed Kubernetes cluster documentation for this part of the process.
Add a worker node
The first element needed to deploy the Hello World application is a worker node in your cluster. To create this node, you can use the POST /kube/{serviceName}/publiccloud/node endpoint, which will deploy a node for your cluster on the Public Cloud.
You will need to give it a flavorName parameter, with the flavor of the instance you want to create. For this tutorial choose a general purpose node, like the b2-7 flavor.
The API will return you the new node information.
Verify your node is ready
You can use the GET /kube/{serviceName}/publiccloud/node entrypoint to list all your nodes. Look for the node you've just created, and verify the status is READY. The node installation can take a minute, so feel free to take a small break, then try again until it's ready.
Deploy your first application
You're now ready to deploy your first application.
For more details about this process, you can refer to the deploying an application documentation.
Did you find this guide useful?
Please feel free to give any suggestions in order to improve this documentation.
Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.
Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.
Thank you. Your feedback has been received.