Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createCluster

Static downloadClusterPrivateRegistryCredentials

  • Download Cluster Private Registry Credentials Download Cluster Private Registry Credentials Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { clusterName: string }
      • clusterName: string

        Cluster name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static downloadClusterProvisionBinary

  • Download Cluster Provision Binary Download Cluster Provision Binary Permission Required: `kelvin.permission.orchestration.read`

    Parameters

    Returns Observable<IKvHttpResponse>

Static downloadClusterProvisionScript

  • Download Cluster Provision Script Download Cluster Provision Script Permission Required: `kelvin.permission.orchestration.read`

    Parameters

    Returns Observable<OrchestrationProvision>

Static getCluster

  • Get Cluster Get Cluster Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { clusterName: string }
      • clusterName: string

        Cluster name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<Cluster>

Static getClusterManifests

  • Get Cluster Manifests Get Cluster Manifests Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { clusterName: string; version: string }
      • clusterName: string

        Cluster name

      • version: string

        Current Version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ClusterManifestList>

Static getPaginator

Static listCluster

  • listCluster(__namedParameters?: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<ClusterListPaginated>

  • List Cluster List Cluster Pagination Sortable Columns: `cluster.name` Permission Required: `kelvin.permission.acp.read`

    Parameters

    • Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}
      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search Cluster by name or title

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ClusterListPaginated>

Static listClusterCIDR

  • listClusterCIDR(__namedParameters?: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<ClusterCIDRListPaginated>

  • List Cluster CIDR List Cluster CIDR Pagination Sortable Columns: `cidr.kube_pod_cidr`, `cidr.kube_service_cidr` Permission Required: `kelvin.permission.acp.read`

    Parameters

    • Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}
      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search CIDR by Kubernetes Pod IP, Kubernetes Service IP or Cluster Name

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ClusterCIDRListPaginated>

Static onError

Static request

Static requestUrl

  • requestUrl<T>(request: IKvHttpRequest, modelClass?: IModel, autenticated?: boolean): Observable<T>

Static updateCluster

  • Update Cluster Update Cluster Permission Required: `kelvin.permission.acp.update`

    Parameters

    Returns Observable<Cluster>