Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ovh-api/kube

UrielCh55MIT4.0.0TypeScript support: included

Add typing to to ovh api kube

ovh, ovhCloud, api, typing, typescript

readme

OVHCloud API client for kube region Europe

This module contains all typing needed to use OvhCloud kube APIs, with hi-level IntelliSense / Code Completion

NPM Version

Setup

With npm:

npm install --save @ovh-api/api
npm install --save @ovh-api/me
npm install --save @ovh-api/kube
... Add all APIs you needs

Usage

import OvhEngine from '@ovh-api/api';
import apiMe from '@ovh-api/me';
import apiKube from '@ovh-api/kube';

const ovhEngine = new OvhEngine({ 
    certCache: './cert-cache.json', // optional cache certificat on disk.
    accessRules: 'GET /kube, GET /kube/*, GET /me', // optional limit the requested privileges.
});

const api = {
    me: apiMe(ovhEngine),
    kube: apiKube(ovhEngine),
}

const test = async () => {
    const { nichandle } = await api.me.$get();
    const data = await api.kube.$get();
    console.log(`${nichandle} have the following services:`);
    console.log(data);
}