The API set allows you to perform CRUD operations to interact with and manage cloudspaces, spot node pools, and on-demand node pools on Rackspace Spot.
Key Concepts:
Organization:Organization is a representation as a collection of cloudspaces (Kubernetes clusters).
Each organization has a unique name and organization ID (
namespace) associated with it.Each organization requires setting up a separate billing account for its management.
Namespace:The namespace is a representation to identify any organization in Spot Platform.
Each organization has a unique namespace associated with it.
The namespace is used to scope resources and operations within the Spot platform.
Each namespace start with
org-.To obtain desired namespace, leverage API: list all organizations to retrieve the details of all organizations, including their associated namespaces.
Cloudspace:Cloudspace is a representation of a Kubernetes cluster in your namespace.
Each cloudspace is associated with a specific region and will contain SpotNodePool and OnDemandNodePool for storing servers bidded on platform.
SpotNodePoolsandOnDemandNodePools:The SpotNodePools and OnDemandNodePools are nodepools that will contain servers that users have bidded for.
When creating the SpotNodePools and OnDemandNodePools, cloudspace should already be created.
Billing should be enabled in your organization for the SpotNodePools and OnDemandNodePools to be created.
Almost all API calls require an Oauth Access Token. Refer authentication. section to obtain the Oauth Access Token.
There are some operations which does not require any oauth token for getting response. They are indicated by (unauthenticated api) in the operation summary.
The unauthenticated api operations are:
- Oauth Token
- Kubeconfig generation
- Price History
- Percentile information
- Market Price Capacity
- You need to generate a Oauth Access Token to make all authenticated API calls.
- You can generate Oauth Access Token using API below Get OAuth token
- Also, append
Bearerkeyword before the Oauth Access Token in authorization header. - Example of authorization header:
Authorization: Bearer <Oauth Access Token>
| Key | In | |
|---|---|---|
| Authorization | Header |
Oauth Token
Oauth Token APIs
Get OAuth token (unauthenticated api)
Retrieve an OAuth Access token for specified a refresh token. Take id_token value from response as Oauth access token value for all subsequent authorization API calls.
| Content | string | Must be set to Default: application/x-www-form-urlencoded |
| object | object | ||
| grant | string | The type of grant needed. Use the literal string Default: refresh_token | |
| client | string | Use Default: mwG3lUMV8KyeMqHe4fJ5Bb3nM1vBvRNa | |
| refresh | string | Obtain a Refresh Token from the API: Rackspace Spot Console. and use it here as request parameter. Steps:
Default: |
curl --request POST \ --url 'https://login.spot.rackspace.com/oauth/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'grant_type=refresh_token' \ --data 'client_id=mwG3lUMV8KyeMqHe4fJ5Bb3nM1vBvRNa' \ --data 'refresh_token=<Enter_refresh_token_here>'Successfully retrieved OAuth token. Take id_token value from response as Oauth access token value for all authorization API calls.
| object | object | ||
| access | string | Access token issued by the authorization server. | |
| id | string | ID token representing the authenticated user. | |
| scope | string | Scopes that were granted by the user. | |
| expires | integer | Time in seconds until the access token expires. | |
| token | string | The type of token issued. |
Unauthorized request. Please provide valid refresh token.
Unexpected error
{ "access_token": "eyJz93a...k4laUWw", "id_token": "eyJhbGci...jsdfsdfs", "scope": "openid profile email offline_access", "expires_in": 86400, "token_type": "Bearer"}Kubeconfig Generation
Kubeconfig generation APIs
Generate kubeconfig (unauthenticated API)
Generates a kubeconfig file for the specified organization and cloudspace using a refresh token. It is unauthenticated api, so doesn't require API token in headers when calling it.
| object | object | ||
| organization | string | Name of the organization for which kubeconfig is to be generated. | |
| cloudspace | string | Name of the cloudspace belonging to the organization. | |
| refresh | string | Refresh token obtained via UI authentication. |
curl --request POST \ --url 'https://spot.rackspace.com/apis/auth.ngpc.rxt.io/v1/generate-kubeconfig' \ --data '{ "organization_name": "my-org", "cloudspace_name": "my-cloudspace", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6..."}'Kubeconfig generated successfully.
| object | object | ||
| data | object | ||
| kubeconfig | string | Full kubeconfig YAML as a string. | |
| message | string | ||
| status | integer |
Bad request. Input parameter is missing or invalid.
Unauthorized. The refresh token is invalid or expired.
{ "data": { "kubeconfig": "apiVersion: v1\nclusters:\n- cluster:\n insecure-skip-tls-verify: true\n server: https://<cluster-api-server>\n name: <cluster-name>\ncontexts:\n- context:\n cluster: <cluster-name>\n namespace: default\n user: <user-name>\n name: <context-name>\ncurrent-context: <context-name>\nkind: Config\npreferences: {}\nusers:\n- name: <user-name>\n user:\n token: <jwt-token>\n- name: oidc\n user:\n exec:\n apiVersion: client.authentication.k8s.io/v1beta1\n command: kubectl\n args:\n - oidc-login\n - get-token\n - --oidc-issuer-url=https://<issuer-url>/\n - --oidc-client-id=<client-id>\n - --oidc-extra-scope=openid\n - --oidc-extra-scope=profile\n - --oidc-extra-scope=email\n - --oidc-auth-request-extra-params=organization=<org-id>\n - --token-cache-dir=~/.kube/cache/oidc-login/<org-id>\n provideClusterInfo: false\n interactiveMode: IfAvailable" }, "message": "kubeconfig generated successfully", "status_code": 200}Region
Region APIs
Get all regions
List objects of kind Region to provide all available regions.
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/regions' \ --header 'Authorization: {Authorization}'Regions obtained successfully
| object | object | RegionList is a list of Region | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| items | array[object] | List of regions. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | Region | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | RegionSpec defines the desired state of Region | |
| country | string | Country describes the country the region is located in. It should adhere to the "ISO 3166-1 alpha-3" standard. See: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes maxLength: 3 minLength: 3 | |
| description | string | Description is a free-form field to provide further description of the region's location. | |
| provider | object | ProviderSpec describes the actual infrastructure/cloud backing the region For example, ironic, ospc, or whatever other clouds we may support | |
| providerRegionName | string | ||
| providerType | string | ProviderSpec describes the actual infrastructure/cloud Provider backing the region For example, ironic, ospc, or whatever other clouds we may support | |
| kind | string | RegionList | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
Unauthorized access
{ "apiVersion": "{string}", "items": [ { "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "country": "{string}", "description": "{string}", "provider": { "providerRegionName": "{string}", "providerType": "{string}" } } } ], "kind": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }}Region By Name
Region by name APIs
Get region by name
Get the specified Region.
| name | string | Use a valid Region name. Some available regions are:
To get more information on available regions, refer to the regions endpoint: |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/regions/{name}' \ --header 'Authorization: {Authorization}'Specific Region obtained successfully
| object | object | Region is the Schema for the regions API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | Region | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | RegionSpec defines the desired state of Region | |
| country | string | Country describes the country the region is located in. It should adhere to the "ISO 3166-1 alpha-3" standard. See: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes maxLength: 3 minLength: 3 | |
| description | string | Description is a free-form field to provide further description of the region's location. | |
| provider | object | ProviderSpec describes the actual infrastructure/cloud backing the region For example, ironic, ospc, or whatever other clouds we may support | |
| providerRegionName | string | ||
| providerType | string | ProviderSpec describes the actual infrastructure/cloud Provider backing the region For example, ironic, ospc, or whatever other clouds we may support |
Unauthorized access
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "country": "{string}", "description": "{string}", "provider": { "providerRegionName": "{string}", "providerType": "{string}" } }}Serverclass
Serverclass APIs
Get all serverclasses
List objects of kind ServerClass to provide all available serverclasses.
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/serverclasses' \ --header 'Authorization: {Authorization}'Serverclasses obtained successfully
| object | object | ServerClassList is a list of ServerClass | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| items | array[object] | List of serverclasses. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | serverclass | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | ServerClassSpec defines the desired state of ServerClass | |
| availability | string | Availability describes the serverclass availability status For example, deprecated | |
| category | string | Category is a loose grouping of ServerClasses into different flavor types For example, general, compute, memory | |
| displayName | string | DisplayName specifies the human-readable name to use. If not set, the metadata.name should be used. | |
| flavorType | string | FlavorType describes whether it is a VM or bare metal. This determines certain capabilities like nested virtualization | |
| onDemandPricing | object | OnDemandPricing contains a basic ondemand pricing for this type of servers. | |
| cost | string | Cost describes the =USD cost of this type of servers. If pricing is localized, this can be used as the base factor. | |
| interval | string | Interval indicates the interval used for the pricing. The format is a golang duration string, for example: 20s, 6m, or 1h6m. | |
| provider | object | Provider contails provider specific names for the flavor and type of cloud | |
| providerFlavorID | string | ProviderFlavorID is the actual flavor ID in the cloud Since ServerClass.Name will be region-specific | |
| providerType | string | ProviderType indicates OSPC vs Ironic, etc... | |
| region | string | Region specifies the region where the servers belonging to this ServerClass resides in. | |
| resources | object | Resources contains the characteristics of the servers that are part of this class of servers. | |
| cpu | string | ||
| memory | string | ||
| status | object | ServerClassStatus defines the observed state of ServerClass | |
| available | integer | Available indicates how many servers of this class are available to be provisioned. | |
| capacity | integer | Capacity describes how many servers are available both online and offline. | |
| lastAuction | integer | ||
| reserved | integer | Reserved shows how many servers of this class are currently in use by organizations. | |
| spotPricing | object | SpotPricing contains a basic spot pricing for this type of servers. This is updated from Auction Controller based on Auction results and market variations. | |
| hammerPricePerHour | string | HammerPricePerHour describes the current =USD cost per hour being billed for this type of servers if reserved as spot. This is intended to be used as an indicator and will vary based on Market conditions. | |
| marketPricePerHour | string | MarketPricePerHour describes the current =USD cost per hour of this type of servers if reserved as spot. This is intended to be used as an indicator and will vary based on Market conditions. | |
| kind | string | ServerClassList | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
Unauthorized access
{ "apiVersion": "{string}", "items": [ { "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "availability": "{string}", "category": "{string}", "displayName": "{string}", "flavorType": "{string}", "onDemandPricing": { "cost": "{string}", "interval": "{string}" }, "provider": { "providerFlavorID": "{string}", "providerType": "{string}" }, "region": "{string}", "resources": { "cpu": "{string}", "memory": "{string}" } }, "status": { "available": "{integer}", "capacity": "{integer}", "lastAuction": "{integer}", "reserved": "{integer}", "spotPricing": { "hammerPricePerHour": "{string}", "marketPricePerHour": "{string}" } } } ], "kind": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }}Serverclass By Name
Serverclass by name APIs
Get serverclass by name
Read the specified ServerClass
| name | string | Use a valid Serverclass name. Some available serverclasses are:
To get more information on available serverclasses, refer to the serverclasses endpoint: ServerClasses. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/serverclasses/{name}' \ --header 'Authorization: {Authorization}'Specific Serverclass obtained successfully
| object | object | ServerClass is the Schema for the serverclasses API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | serverclass | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | ServerClassSpec defines the desired state of ServerClass | |
| availability | string | Availability describes the serverclass availability status For example, deprecated | |
| category | string | Category is a loose grouping of ServerClasses into different flavor types For example, general, compute, memory | |
| displayName | string | DisplayName specifies the human-readable name to use. If not set, the metadata.name should be used. | |
| flavorType | string | FlavorType describes whether it is a VM or bare metal. This determines certain capabilities like nested virtualization | |
| onDemandPricing | object | OnDemandPricing contains a basic ondemand pricing for this type of servers. | |
| cost | string | Cost describes the =USD cost of this type of servers. If pricing is localized, this can be used as the base factor. | |
| interval | string | Interval indicates the interval used for the pricing. The format is a golang duration string, for example: 20s, 6m, or 1h6m. | |
| provider | object | Provider contails provider specific names for the flavor and type of cloud | |
| providerFlavorID | string | ProviderFlavorID is the actual flavor ID in the cloud Since ServerClass.Name will be region-specific | |
| providerType | string | ProviderType indicates OSPC vs Ironic, etc... | |
| region | string | Region specifies the region where the servers belonging to this ServerClass resides in. | |
| resources | object | Resources contains the characteristics of the servers that are part of this class of servers. | |
| cpu | string | ||
| memory | string | ||
| status | object | ServerClassStatus defines the observed state of ServerClass | |
| available | integer | Available indicates how many servers of this class are available to be provisioned. | |
| capacity | integer | Capacity describes how many servers are available both online and offline. | |
| lastAuction | integer | ||
| reserved | integer | Reserved shows how many servers of this class are currently in use by organizations. | |
| spotPricing | object | SpotPricing contains a basic spot pricing for this type of servers. This is updated from Auction Controller based on Auction results and market variations. | |
| hammerPricePerHour | string | HammerPricePerHour describes the current =USD cost per hour being billed for this type of servers if reserved as spot. This is intended to be used as an indicator and will vary based on Market conditions. | |
| marketPricePerHour | string | MarketPricePerHour describes the current =USD cost per hour of this type of servers if reserved as spot. This is intended to be used as an indicator and will vary based on Market conditions. |
Unauthorized access
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "availability": "{string}", "category": "{string}", "displayName": "{string}", "flavorType": "{string}", "onDemandPricing": { "cost": "{string}", "interval": "{string}" }, "provider": { "providerFlavorID": "{string}", "providerType": "{string}" }, "region": "{string}", "resources": { "cpu": "{string}", "memory": "{string}" } }, "status": { "available": "{integer}", "capacity": "{integer}", "lastAuction": "{integer}", "reserved": "{integer}", "spotPricing": { "hammerPricePerHour": "{string}", "marketPricePerHour": "{string}" } }}Organization Api
Organizations APIs
List all organizations
List all organizations along with their details, including the associated namespaces.
curl --get \ --url 'https://spot.rackspace.com/apis/auth.ngpc.rxt.io/v1/organizations' \ --header 'Authorization: {Authorization}'Successfully retrieved the list of organizations and namespaces.
| object | object | ||
| start | integer | Starting index for pagination. | |
| limit | integer | Limit for the number of items per page. | |
| length | integer | Number of organizations in the response. | |
| total | integer | Total number of organizations available. | |
| next | string | URL for the next page of results (if available). | |
| organizations | array[object] | ||
| id | string | The unique ID of the organization. | |
| name | string | The name of the organization. | |
| display | string | The display name of the organization. | |
| metadata | object | ||
| namespace | string | The namespace associated with the organization. |
Bad Request.
Unauthorized.
Internal Server Error. An unexpected error occurred while processing the request.
{ "start": "{integer}", "limit": "{integer}", "length": "{integer}", "total": "{integer}", "next": "{string}", "organizations": [ { "id": "{string}", "name": "{string}", "display_name": "{string}", "metadata": { "namespace": "{string}" } } ]}Get all cloudspaces
Retrieve all CloudSpaces from the specified namespace.
| namespace | string | The namespace to which the Cloudspace belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/cloudspaces' \ --header 'Authorization: {Authorization}'CloudSpaces obtained successfully.
| object | object | CloudSpaceList is a list of CloudSpace | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| items | array[object] | List of cloudspaces. | |
| apiVersion | string | ngpc.rxt.io/v1 Default: ngpc.rxt.io/v1 | |
| kind | string | CloudSpace Default: CloudSpace | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | CloudSpaceSpec defines the desired state of CloudSpace | |
| HAControlPlane | boolean | Set to Enable control plane HA and setting HACount Default: false | |
| bidRequests | array[string] | Contains a list of SpotNodePool requests | |
| cloud | string | Cloud describes to which Cloud the CloudSpace belongs to. Cloud is required if deploymentType=gen1 Default: default | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK. Setting this field will disable discovery and override any discovered cluster.
| |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| cni | string | CNI specifies the Container Network Interface (CNI) to be used. Supported values: calico, cilium, byocni Enum: | |
| deploymentType | string | DeploymentType specifies which deploymentType the CloudSpace should use. options: gen1 - PMK/legacy type, gen2 - CAPI based Enum: | |
| kubernetesVersion | string | KubernetesVersion specifies the version of Kubernetes to deploy. | |
| networks | array[object] | Networks contain the configuration of the VM networks in this CloudSpace. | |
| name | string | ||
| subnet | string | ||
| onDemandRequests | array[string] | Contains a list of OnDemand requests | |
| region | string | Region specifies the region which the CloudSpace should be in. | |
| servers | array[object] | Servers contains the requested set of servers for this CloudSpace. | |
| class | string | ||
| count | integer | ||
| type | string | Type of CloudSpace | |
| webhook | string | Optional webhook that will be invoked when Servers of this CloudSpace are released | |
| status | object | CloudSpaceStatus defines the observed state of CloudSpace | |
| APIServerEndpoint | string | ||
| assignedServers | object | ServerStatus contains status of servers configuring | |
| * | object | ||
| IP | string | ||
| clusterRole | string | ||
| error | string | ||
| serverClassName | string | ||
| serverName | string | ||
| serverType | string | ||
| state | string | ||
| bids | object | Map of each bid and it's WonCount status | |
| * | object | ||
| bidName | string | ||
| type | string | ||
| wonCount | integer | ||
| cloudspaceClassName | string | CloudspaceClass that this cloudspace uses, valid only if deploymentType=gen2. Will be assigned by Cloudspace controller during cloudspace creation | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK.
| |
| cluster | object | ObjectReference contains enough information to let you inspect or modify the referred object.New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| reason | string | ||
| status | string | ||
| conditions | array[object] | Conditions defines current service state of the CloudSpace. | |
| lastTransitionTime | date-time | Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | |
| message | string | A human readable message indicating details about the transition. This field may be empty. | |
| reason | string | The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty. | |
| severity | string | Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False. | |
| status | string | Status of the condition, one of True, False, Unknown. | |
| type | string | Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. | |
| currentKubernetesVersion | string | CurrentKubernetesVersion contains the current version of Kubernetes running in the CloudSpace | |
| firstReadyTimestamp | date-time | Contains the time at which the cloudspace first moved to Ready phase | |
| health | string | Health indicates if CloudSpace has a working APIServer and available nodes | |
| pendingAllocations | object | Outstanding pooler Allocation IDs for Cloud Instances | |
| * | object | ||
| allocatedCount | integer | ||
| bidName | string | ||
| bidType | string | ||
| count | integer | ||
| serverClassName | string | ||
| phase | string | Phase indicates the current state of the Cloud. | |
| reason | string | Reason contains the reason why the CloudSpace is in a certain phase. | |
| sshSecretName | string | SSHSecretName contains the SSH Key Secret to access nodes in the CloudSpace | |
| upgradePhase | string | UpgradePhase indicates the current state of the CloudSpace upgrade | |
| kind | string | CloudSpaceList | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
Unauthorized access.
xxxxxxxxxx{ "apiVersion": "{string}", "items": [...], "kind": "{string}", "metadata": {...}}Create cloudspace
Create a CloudSpace in the specified namespace.
| namespace | string | The namespace to which the Cloudspace belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
Use value for
apiVersionasngpc.rxt.io/v1.Use value for
kindasCloudSpace.In the
metadataobject:Enter a value for the
namefield to name your CloudSpace.Select the
namespacein which the CloudSpace should be created. This should match thenamespaceused in the path parameter above.creationTimestampanddeletionTimestamp: Represents timestamp for cloudspace creation. Leave it as default only.
In the
specobject:Provide the
regionfrom the list returned by the Regions API.Enter the
webhookURL (Slack channel webhook) to receive node preemption event notifications.Choose the
kubernetesVersionfor your CloudSpace. Currently available versions are:- 1.31.1(latest)
- 1.30.10
- 1.29.6
You can leave
cloud,cni, andHAControlPlanefields as default unless custom values are needed.
| object | object | CloudSpace is the Schema for the cloudspaces API | |
| apiVersion | string | ngpc.rxt.io/v1 Default: ngpc.rxt.io/v1 | |
| kind | string | CloudSpace Default: CloudSpace | |
| metadata | object | Additional information | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| spec | object | CloudSpaceSpec defines the desired state of CloudSpace | |
| HAControlPlane | boolean | Set to Enable control plane HA and setting HACount Default: false | |
| cloud | string | Cloud describes to which Cloud the CloudSpace belongs to. Cloud is required if deploymentType=gen1 Default: default | |
| cni | string | CNI specifies the Container Network Interface (CNI) to be used. Supported values: calico, cilium, byocni Enum: | |
| kubernetesVersion | string | KubernetesVersion specifies the version of Kubernetes to deploy. | |
| region | string | Region specifies the region which the CloudSpace should be in. | |
| webhook | string | Optional webhook that will be invoked when Servers of this CloudSpace are released |
curl --request POST \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/cloudspaces' \ --header 'Authorization: {Authorization}' \ --data '{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "name": "{string}", "namespace": "{string}" }, "spec": { "HAControlPlane": "{boolean}", "cloud": "{string}", "cni": "{string}", "kubernetesVersion": "{string}", "region": "{string}", "webhook": "{string}" }}'CloudSpace creation request submitted successfully.
| object | object | CloudSpace is the Schema for the cloudspaces API | |
| apiVersion | string | ngpc.rxt.io/v1 Default: ngpc.rxt.io/v1 | |
| kind | string | CloudSpace Default: CloudSpace | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | CloudSpaceSpec defines the desired state of CloudSpace | |
| HAControlPlane | boolean | Set to Enable control plane HA and setting HACount Default: false | |
| bidRequests | array[string] | Contains a list of SpotNodePool requests | |
| cloud | string | Cloud describes to which Cloud the CloudSpace belongs to. Cloud is required if deploymentType=gen1 Default: default | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK. Setting this field will disable discovery and override any discovered cluster.
| |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| cni | string | CNI specifies the Container Network Interface (CNI) to be used. Supported values: calico, cilium, byocni Enum: | |
| deploymentType | string | DeploymentType specifies which deploymentType the CloudSpace should use. options: gen1 - PMK/legacy type, gen2 - CAPI based Enum: | |
| kubernetesVersion | string | KubernetesVersion specifies the version of Kubernetes to deploy. | |
| networks | array[object] | Networks contain the configuration of the VM networks in this CloudSpace. | |
| name | string | ||
| subnet | string | ||
| onDemandRequests | array[string] | Contains a list of OnDemand requests | |
| region | string | Region specifies the region which the CloudSpace should be in. | |
| servers | array[object] | Servers contains the requested set of servers for this CloudSpace. | |
| class | string | ||
| count | integer | ||
| type | string | Type of CloudSpace | |
| webhook | string | Optional webhook that will be invoked when Servers of this CloudSpace are released | |
| status | object | CloudSpaceStatus defines the observed state of CloudSpace | |
| APIServerEndpoint | string | ||
| assignedServers | object | ServerStatus contains status of servers configuring | |
| * | object | ||
| IP | string | ||
| clusterRole | string | ||
| error | string | ||
| serverClassName | string | ||
| serverName | string | ||
| serverType | string | ||
| state | string | ||
| bids | object | Map of each bid and it's WonCount status | |
| * | object | ||
| bidName | string | ||
| type | string | ||
| wonCount | integer | ||
| cloudspaceClassName | string | CloudspaceClass that this cloudspace uses, valid only if deploymentType=gen2. Will be assigned by Cloudspace controller during cloudspace creation | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK.
| |
| cluster | object | ObjectReference contains enough information to let you inspect or modify the referred object.New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| reason | string | ||
| status | string | ||
| conditions | array[object] | Conditions defines current service state of the CloudSpace. | |
| lastTransitionTime | date-time | Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | |
| message | string | A human readable message indicating details about the transition. This field may be empty. | |
| reason | string | The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty. | |
| severity | string | Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False. | |
| status | string | Status of the condition, one of True, False, Unknown. | |
| type | string | Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. | |
| currentKubernetesVersion | string | CurrentKubernetesVersion contains the current version of Kubernetes running in the CloudSpace | |
| firstReadyTimestamp | date-time | Contains the time at which the cloudspace first moved to Ready phase | |
| health | string | Health indicates if CloudSpace has a working APIServer and available nodes | |
| pendingAllocations | object | Outstanding pooler Allocation IDs for Cloud Instances | |
| * | object | ||
| allocatedCount | integer | ||
| bidName | string | ||
| bidType | string | ||
| count | integer | ||
| serverClassName | string | ||
| phase | string | Phase indicates the current state of the Cloud. | |
| reason | string | Reason contains the reason why the CloudSpace is in a certain phase. | |
| sshSecretName | string | SSHSecretName contains the SSH Key Secret to access nodes in the CloudSpace | |
| upgradePhase | string | UpgradePhase indicates the current state of the CloudSpace upgrade |
CloudSpace created successfully.
CloudSpace creation request accepted successfully.
Unauthorized access.
xxxxxxxxxx{ "apiVersion": "{string}", "kind": "{string}", "metadata": {...}, "spec": {...}, "status": {...}}Delete all cloudspaces
Delete CloudSpaces from the specified namespace.
| namespace | string | The namespace to which the Cloudspace belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --request DELETE \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/cloudspaces' \ --header 'Authorization: {Authorization}'CloudSpaces deleted successfully.
| object | object | Status is a return value for calls that don't return other objects. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| code | int32 | Suggested HTTP return code for this status, 0 if not set. | |
| details | object | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. | |
| causes | array[object] | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | |
| field | string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items [ 0 ].name" - the field "name" on the first array entry in "items" | |
| message | string | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | |
| reason | string | A machine-readable description of the cause of the error. If this value is empty there is no information available. | |
| group | string | The group attribute of the resource associated with the status StatusReason. | |
| kind | string | ||
| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | |
| retryAfterSeconds | int32 | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | |
| uid | string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| kind | string | Kind of kubernetes resource | |
| message | string | A human-readable description of the status of this operation. | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| reason | string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | |
| status | string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
Unauthorized access.
{ "apiVersion": "{string}", "code": "{int32}", "details": { "causes": [ { "field": "{string}", "message": "{string}", "reason": "{string}" } ], "group": "{string}", "kind": "{string}", "name": "{string}", "retryAfterSeconds": "{int32}", "uid": "{string}" }, "kind": "{string}", "message": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }, "reason": "{string}", "status": "{string}"}Cloudspace By Name
Cloudspace by name APIs
Get cloudspace by name
Retrieves the details of a CloudSpace by its name from the specified namespace.
| name | string | CloudSpace Name | |
| namespace | string | The namespace to which the Cloudspace belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/cloudspaces/{name}' \ --header 'Authorization: {Authorization}'Specific CloudSpace obtained successfully.
| object | object | CloudSpace is the Schema for the cloudspaces API | |
| apiVersion | string | ngpc.rxt.io/v1 Default: ngpc.rxt.io/v1 | |
| kind | string | CloudSpace Default: CloudSpace | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | CloudSpaceSpec defines the desired state of CloudSpace | |
| HAControlPlane | boolean | Set to Enable control plane HA and setting HACount Default: false | |
| bidRequests | array[string] | Contains a list of SpotNodePool requests | |
| cloud | string | Cloud describes to which Cloud the CloudSpace belongs to. Cloud is required if deploymentType=gen1 Default: default | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK. Setting this field will disable discovery and override any discovered cluster.
| |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| cni | string | CNI specifies the Container Network Interface (CNI) to be used. Supported values: calico, cilium, byocni Enum: | |
| deploymentType | string | DeploymentType specifies which deploymentType the CloudSpace should use. options: gen1 - PMK/legacy type, gen2 - CAPI based Enum: | |
| kubernetesVersion | string | KubernetesVersion specifies the version of Kubernetes to deploy. | |
| networks | array[object] | Networks contain the configuration of the VM networks in this CloudSpace. | |
| name | string | ||
| subnet | string | ||
| onDemandRequests | array[string] | Contains a list of OnDemand requests | |
| region | string | Region specifies the region which the CloudSpace should be in. | |
| servers | array[object] | Servers contains the requested set of servers for this CloudSpace. | |
| class | string | ||
| count | integer | ||
| type | string | Type of CloudSpace | |
| webhook | string | Optional webhook that will be invoked when Servers of this CloudSpace are released | |
| status | object | CloudSpaceStatus defines the observed state of CloudSpace | |
| APIServerEndpoint | string | ||
| assignedServers | object | ServerStatus contains status of servers configuring | |
| * | object | ||
| IP | string | ||
| clusterRole | string | ||
| error | string | ||
| serverClassName | string | ||
| serverName | string | ||
| serverType | string | ||
| state | string | ||
| bids | object | Map of each bid and it's WonCount status | |
| * | object | ||
| bidName | string | ||
| type | string | ||
| wonCount | integer | ||
| cloudspaceClassName | string | CloudspaceClass that this cloudspace uses, valid only if deploymentType=gen2. Will be assigned by Cloudspace controller during cloudspace creation | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK.
| |
| cluster | object | ObjectReference contains enough information to let you inspect or modify the referred object.New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| reason | string | ||
| status | string | ||
| conditions | array[object] | Conditions defines current service state of the CloudSpace. | |
| lastTransitionTime | date-time | Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | |
| message | string | A human readable message indicating details about the transition. This field may be empty. | |
| reason | string | The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty. | |
| severity | string | Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False. | |
| status | string | Status of the condition, one of True, False, Unknown. | |
| type | string | Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. | |
| currentKubernetesVersion | string | CurrentKubernetesVersion contains the current version of Kubernetes running in the CloudSpace | |
| firstReadyTimestamp | date-time | Contains the time at which the cloudspace first moved to Ready phase | |
| health | string | Health indicates if CloudSpace has a working APIServer and available nodes | |
| pendingAllocations | object | Outstanding pooler Allocation IDs for Cloud Instances | |
| * | object | ||
| allocatedCount | integer | ||
| bidName | string | ||
| bidType | string | ||
| count | integer | ||
| serverClassName | string | ||
| phase | string | Phase indicates the current state of the Cloud. | |
| reason | string | Reason contains the reason why the CloudSpace is in a certain phase. | |
| sshSecretName | string | SSHSecretName contains the SSH Key Secret to access nodes in the CloudSpace | |
| upgradePhase | string | UpgradePhase indicates the current state of the CloudSpace upgrade |
Unauthorized access.
xxxxxxxxxx{ "apiVersion": "{string}", "kind": "{string}", "metadata": {...}, "spec": {...}, "status": {...}}Delete cloudspace by name
Delete a CloudSpace by its name from the specified namespace.
| name | string | name of the CloudSpace | |
| namespace | string | TThe namespace to which the Cloudspace belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --request DELETE \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/cloudspaces/{name}' \ --header 'Authorization: {Authorization}'Specific CloudSpace deletion request submitted successfully.
| object | object | Status is a return value for calls that don't return other objects. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| code | int32 | Suggested HTTP return code for this status, 0 if not set. | |
| details | object | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. | |
| causes | array[object] | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | |
| field | string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items [ 0 ].name" - the field "name" on the first array entry in "items" | |
| message | string | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | |
| reason | string | A machine-readable description of the cause of the error. If this value is empty there is no information available. | |
| group | string | The group attribute of the resource associated with the status StatusReason. | |
| kind | string | ||
| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | |
| retryAfterSeconds | int32 | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | |
| uid | string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| kind | string | Kind of kubernetes resource | |
| message | string | A human-readable description of the status of this operation. | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| reason | string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | |
| status | string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
Specific CloudSpace deletion request accepted successfully.
Unauthorized access.
{ "apiVersion": "{string}", "code": "{int32}", "details": { "causes": [ { "field": "{string}", "message": "{string}", "reason": "{string}" } ], "group": "{string}", "kind": "{string}", "name": "{string}", "retryAfterSeconds": "{int32}", "uid": "{string}" }, "kind": "{string}", "message": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }, "reason": "{string}", "status": "{string}"}Edit cloudspace by name
Update a CloudSpace by its name from the specified namespace.
| name | string | name of the CloudSpace | |
| namespace | string | The namespace to which the Cloudspace belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
This endpoint allows you to perform operations on the cloudspace configuration.
op: Represents the operation to be performed.add: Adds a new field or value at the specifiedpathin spec section of object.replace: Replaces the existing value at the specifiedpathin spec section of object.
path: Specifies the location within the object where the operation should be applied.- For example, to add a new field, use /spec/newField.
- To replace an existing field, use /spec/existingField.
value: Represents the data to be added or replaced at the specified path.
| object | object | Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. |
curl --request PATCH \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/cloudspaces/{name}' \ --header 'Authorization: {Authorization}' \ --data '[ { "op": "replace", "path": "/spec/someSpec1", "value": "anotherValue" }, { "op": "add", "path": "/spec/someSpec2", "value": "newValue" }]'CloudSpace updated successfully.
| object | object | CloudSpace is the Schema for the cloudspaces API | |
| apiVersion | string | ngpc.rxt.io/v1 Default: ngpc.rxt.io/v1 | |
| kind | string | CloudSpace Default: CloudSpace | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | CloudSpaceSpec defines the desired state of CloudSpace | |
| HAControlPlane | boolean | Set to Enable control plane HA and setting HACount Default: false | |
| bidRequests | array[string] | Contains a list of SpotNodePool requests | |
| cloud | string | Cloud describes to which Cloud the CloudSpace belongs to. Cloud is required if deploymentType=gen1 Default: default | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK. Setting this field will disable discovery and override any discovered cluster.
| |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| cni | string | CNI specifies the Container Network Interface (CNI) to be used. Supported values: calico, cilium, byocni Enum: | |
| deploymentType | string | DeploymentType specifies which deploymentType the CloudSpace should use. options: gen1 - PMK/legacy type, gen2 - CAPI based Enum: | |
| kubernetesVersion | string | KubernetesVersion specifies the version of Kubernetes to deploy. | |
| networks | array[object] | Networks contain the configuration of the VM networks in this CloudSpace. | |
| name | string | ||
| subnet | string | ||
| onDemandRequests | array[string] | Contains a list of OnDemand requests | |
| region | string | Region specifies the region which the CloudSpace should be in. | |
| servers | array[object] | Servers contains the requested set of servers for this CloudSpace. | |
| class | string | ||
| count | integer | ||
| type | string | Type of CloudSpace | |
| webhook | string | Optional webhook that will be invoked when Servers of this CloudSpace are released | |
| status | object | CloudSpaceStatus defines the observed state of CloudSpace | |
| APIServerEndpoint | string | ||
| assignedServers | object | ServerStatus contains status of servers configuring | |
| * | object | ||
| IP | string | ||
| clusterRole | string | ||
| error | string | ||
| serverClassName | string | ||
| serverName | string | ||
| serverType | string | ||
| state | string | ||
| bids | object | Map of each bid and it's WonCount status | |
| * | object | ||
| bidName | string | ||
| type | string | ||
| wonCount | integer | ||
| cloudspaceClassName | string | CloudspaceClass that this cloudspace uses, valid only if deploymentType=gen2. Will be assigned by Cloudspace controller during cloudspace creation | |
| clusterRef | object | ClusterRef contains a reference to the Cluster in PMK.
| |
| cluster | object | ObjectReference contains enough information to let you inspect or modify the referred object.New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers { name }" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers [ 2 ]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. | |
| kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | |
| reason | string | ||
| status | string | ||
| conditions | array[object] | Conditions defines current service state of the CloudSpace. | |
| lastTransitionTime | date-time | Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | |
| message | string | A human readable message indicating details about the transition. This field may be empty. | |
| reason | string | The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty. | |
| severity | string | Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False. | |
| status | string | Status of the condition, one of True, False, Unknown. | |
| type | string | Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. | |
| currentKubernetesVersion | string | CurrentKubernetesVersion contains the current version of Kubernetes running in the CloudSpace | |
| firstReadyTimestamp | date-time | Contains the time at which the cloudspace first moved to Ready phase | |
| health | string | Health indicates if CloudSpace has a working APIServer and available nodes | |
| pendingAllocations | object | Outstanding pooler Allocation IDs for Cloud Instances | |
| * | object | ||
| allocatedCount | integer | ||
| bidName | string | ||
| bidType | string | ||
| count | integer | ||
| serverClassName | string | ||
| phase | string | Phase indicates the current state of the Cloud. | |
| reason | string | Reason contains the reason why the CloudSpace is in a certain phase. | |
| sshSecretName | string | SSHSecretName contains the SSH Key Secret to access nodes in the CloudSpace | |
| upgradePhase | string | UpgradePhase indicates the current state of the CloudSpace upgrade |
Unauthorized access.
xxxxxxxxxx{ "apiVersion": "{string}", "kind": "{string}", "metadata": {...}, "spec": {...}, "status": {...}}Get all spotnodepools
Retrieve all SpotNodePools from the specified namespace.
| namespace | string | The namespace to which the SpotNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/spotnodepools' \ --header 'Authorization: {Authorization}'SpotNodePools obtained successfully.
| object | object | SpotNodePoolList is a list of SpotNodePool | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| items | array[object] | List of spotnodepools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | SpotNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | SpotNodePoolSpec defines the desired state of SpotNodePool | |
| autoscaling | object | Autoscaling automatically adjusts the number of servers based on demand. | |
| enabled | boolean | Enables autoscaling when set to true. Default: false | |
| maxNodes | integer | The maximum number of servers the SpotNodePool can scale up to when autoscaling is enabled. | |
| minNodes | integer | The minimum number of servers that should remain available in the SpotNodePool when autoscaling is enabled. | |
| bidPrice | string | The maximum price you are willing to bid for each server. The bid price must be at least equal to the market price of the selected serverClass for successful server allocation. Servers will be billed at the market price until the market price reaches the bid price, at which point the servers will be preempted. | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of SpotNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of SpotNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of SpotNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the SpotNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | SpotNodePoolStatus defines the observed state of SpotNodePool | |
| bidStatus | string | Bid status for bid at given bidPrice. | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| wonCount | integer | No of Spot Servers won | |
| kind | string | SpotNodePoolList | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
Unauthorized access.
{ "apiVersion": "{string}", "items": [ { "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "autoscaling": { "enabled": "{boolean}", "maxNodes": "{integer}", "minNodes": "{integer}" }, "bidPrice": "{string}", "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "bidStatus": "{string}", "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "wonCount": "{integer}" } } ], "kind": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }}Create spotnodepool
Create a SpotNodePool in the specified namespace.
| namespace | string | The namespace to which the SpotNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
Use value for
apiVersionasngpc.rxt.io/v1.Use value for
kindasSpotNodePool.In the
metadataobject:Enter a value for the
namefield in themetadataobject to name your SpotNodePool. The name must be alowercase UUIDonly.Select the
namespacein which the SpotNodePool should be created. This should match thenamespaceused in the path parameter above.creationTimestampanddeletionTimestamp: Represents timestamp for SpotNodePool creation. Leave it as default only.
In the
specobject:autoscaling: Configure autoscaling settings.enabled: Set whether autoscaling is enabled. (e.g., true or false)maxNodes: The maximum number of nodes allowed when autoscaling is enabled.minNodes: The minimum number of nodes required when autoscaling is enabled.
bidPrice: Define the bid price to bid for the spot servers (instances).cloudSpace: Specify the name of your cloudspace in which SpotNodePool should be created.desired: The desired number of resources (nodes) to be provisioned.serverClass: Specify the Serverclass type for the cloudspace. Refer to Serverclass api for available serverclasses.
| object | object | SpotNodePool is the Schema for the spotnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | SpotNodePool | |
| metadata | object | Additional information | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| spec | object | SpotNodePoolSpec defines the desired state of SpotNodePool | |
| autoscaling | object | Autoscaling automatically adjusts the number of servers based on demand. | |
| enabled | boolean | Enables autoscaling when set to true. Default: false | |
| maxNodes | integer | The maximum number of servers the SpotNodePool can scale up to when autoscaling is enabled. | |
| minNodes | integer | The minimum number of servers that should remain available in the SpotNodePool when autoscaling is enabled. | |
| bidPrice | string | The maximum price you are willing to bid for each server. The bid price must be at least equal to the market price of the selected serverClass for successful server allocation. Servers will be billed at the market price until the market price reaches the bid price, at which point the servers will be preempted. | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| desired | integer | Number of Spot Servers required within the SpotNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. |
curl --request POST \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/spotnodepools' \ --header 'Authorization: {Authorization}' \ --data '{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "name": "{string}", "namespace": "{string}" }, "spec": { "autoscaling": { "enabled": "{boolean}", "maxNodes": "{integer}", "minNodes": "{integer}" }, "bidPrice": "{string}", "cloudSpace": "{string}", "desired": "{integer}", "serverClass": "{string}" }}'SpotNodePool creation request submitted successfully.
| object | object | SpotNodePool is the Schema for the spotnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | SpotNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | SpotNodePoolSpec defines the desired state of SpotNodePool | |
| autoscaling | object | Autoscaling automatically adjusts the number of servers based on demand. | |
| enabled | boolean | Enables autoscaling when set to true. Default: false | |
| maxNodes | integer | The maximum number of servers the SpotNodePool can scale up to when autoscaling is enabled. | |
| minNodes | integer | The minimum number of servers that should remain available in the SpotNodePool when autoscaling is enabled. | |
| bidPrice | string | The maximum price you are willing to bid for each server. The bid price must be at least equal to the market price of the selected serverClass for successful server allocation. Servers will be billed at the market price until the market price reaches the bid price, at which point the servers will be preempted. | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of SpotNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of SpotNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of SpotNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the SpotNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | SpotNodePoolStatus defines the observed state of SpotNodePool | |
| bidStatus | string | Bid status for bid at given bidPrice. | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| wonCount | integer | No of Spot Servers won |
SpotNodePool created successfully.
SpotNodePool creation request accepted successfully.
Unauthorized access.
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "autoscaling": { "enabled": "{boolean}", "maxNodes": "{integer}", "minNodes": "{integer}" }, "bidPrice": "{string}", "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "bidStatus": "{string}", "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "wonCount": "{integer}" }}Delete all spotnodepools
Delete all SpotNodePools from the specified namespace.
| namespace | string | The namespace to which the SpotNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --request DELETE \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/spotnodepools' \ --header 'Authorization: {Authorization}'SpotNodePools deleted successfully.
| object | object | Status is a return value for calls that don't return other objects. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| code | int32 | Suggested HTTP return code for this status, 0 if not set. | |
| details | object | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. | |
| causes | array[object] | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | |
| field | string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items [ 0 ].name" - the field "name" on the first array entry in "items" | |
| message | string | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | |
| reason | string | A machine-readable description of the cause of the error. If this value is empty there is no information available. | |
| group | string | The group attribute of the resource associated with the status StatusReason. | |
| kind | string | ||
| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | |
| retryAfterSeconds | int32 | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | |
| uid | string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| kind | string | Kind of kubernetes resource | |
| message | string | A human-readable description of the status of this operation. | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| reason | string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | |
| status | string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
Unauthorized access.
{ "apiVersion": "{string}", "code": "{int32}", "details": { "causes": [ { "field": "{string}", "message": "{string}", "reason": "{string}" } ], "group": "{string}", "kind": "{string}", "name": "{string}", "retryAfterSeconds": "{int32}", "uid": "{string}" }, "kind": "{string}", "message": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }, "reason": "{string}", "status": "{string}"}Spot Node Pool By Name
SpotNodePool by name APIs
Get spotnodepool by name
Retrieves the details of a SpotNodePool by its name from the specified namespace.
| name | string | SpotNodePool name, must be a lowercase UUID. | |
| namespace | string | The namespace to which the SpotNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/spotnodepools/{name}' \ --header 'Authorization: {Authorization}'Specific SpotNodePool obtained successfully.
| object | object | SpotNodePool is the Schema for the spotnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | SpotNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | SpotNodePoolSpec defines the desired state of SpotNodePool | |
| autoscaling | object | Autoscaling automatically adjusts the number of servers based on demand. | |
| enabled | boolean | Enables autoscaling when set to true. Default: false | |
| maxNodes | integer | The maximum number of servers the SpotNodePool can scale up to when autoscaling is enabled. | |
| minNodes | integer | The minimum number of servers that should remain available in the SpotNodePool when autoscaling is enabled. | |
| bidPrice | string | The maximum price you are willing to bid for each server. The bid price must be at least equal to the market price of the selected serverClass for successful server allocation. Servers will be billed at the market price until the market price reaches the bid price, at which point the servers will be preempted. | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of SpotNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of SpotNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of SpotNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the SpotNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | SpotNodePoolStatus defines the observed state of SpotNodePool | |
| bidStatus | string | Bid status for bid at given bidPrice. | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| wonCount | integer | No of Spot Servers won |
Unauthorized access.
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "autoscaling": { "enabled": "{boolean}", "maxNodes": "{integer}", "minNodes": "{integer}" }, "bidPrice": "{string}", "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "bidStatus": "{string}", "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "wonCount": "{integer}" }}Delete spotnodepool by name
Delete a SpotNodePool by its name from the specified namespace.
| name | string | SpotNodePool name, must be a lowercase UUID. | |
| namespace | string | The namespace to which the SpotNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --request DELETE \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/spotnodepools/{name}' \ --header 'Authorization: {Authorization}'Specific SpotNodePool deletion request submitted successfully.
| object | object | Status is a return value for calls that don't return other objects. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| code | int32 | Suggested HTTP return code for this status, 0 if not set. | |
| details | object | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. | |
| causes | array[object] | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | |
| field | string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items [ 0 ].name" - the field "name" on the first array entry in "items" | |
| message | string | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | |
| reason | string | A machine-readable description of the cause of the error. If this value is empty there is no information available. | |
| group | string | The group attribute of the resource associated with the status StatusReason. | |
| kind | string | ||
| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | |
| retryAfterSeconds | int32 | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | |
| uid | string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| kind | string | Kind of kubernetes resource | |
| message | string | A human-readable description of the status of this operation. | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| reason | string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | |
| status | string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
Specific SpotNodePool deletion request accepted successfully.
Unauthorized access
{ "apiVersion": "{string}", "code": "{int32}", "details": { "causes": [ { "field": "{string}", "message": "{string}", "reason": "{string}" } ], "group": "{string}", "kind": "{string}", "name": "{string}", "retryAfterSeconds": "{int32}", "uid": "{string}" }, "kind": "{string}", "message": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }, "reason": "{string}", "status": "{string}"}Edit spotnodepool by name
Update a SpotNodePool by its name from the specified namespace.
| name | string | SpotNodePool name, must be a lowercase UUID. | |
| namespace | string | The namespace to which the SpotNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
This endpoint allows you to perform operations on the SpotNodePool configuration.
op: Represents the operation to be performed.add: Adds a new field or value at the specifiedpathin spec section of object.replace: Replaces the existing value at the specifiedpathin spec section of object.
path: Specifies the location within the object where the operation should be applied.- For example, to add a new field, use /spec/newField.
- To replace an existing field, use /spec/existingField.
value: Represents the data to be added or replaced at the specified path.
| object | object | Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. |
curl --request PATCH \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/spotnodepools/{name}' \ --header 'Authorization: {Authorization}' \ --data '[ { "op": "replace", "path": "/spec/someSpec1", "value": "anotherValue" }, { "op": "add", "path": "/spec/someSpec2", "value": "newValue" }]'SpotNodePool updated successfully.
| object | object | SpotNodePool is the Schema for the spotnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | SpotNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | SpotNodePoolSpec defines the desired state of SpotNodePool | |
| autoscaling | object | Autoscaling automatically adjusts the number of servers based on demand. | |
| enabled | boolean | Enables autoscaling when set to true. Default: false | |
| maxNodes | integer | The maximum number of servers the SpotNodePool can scale up to when autoscaling is enabled. | |
| minNodes | integer | The minimum number of servers that should remain available in the SpotNodePool when autoscaling is enabled. | |
| bidPrice | string | The maximum price you are willing to bid for each server. The bid price must be at least equal to the market price of the selected serverClass for successful server allocation. Servers will be billed at the market price until the market price reaches the bid price, at which point the servers will be preempted. | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of SpotNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of SpotNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of SpotNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the SpotNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | SpotNodePoolStatus defines the observed state of SpotNodePool | |
| bidStatus | string | Bid status for bid at given bidPrice. | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| wonCount | integer | No of Spot Servers won |
Unauthorized access.
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "autoscaling": { "enabled": "{boolean}", "maxNodes": "{integer}", "minNodes": "{integer}" }, "bidPrice": "{string}", "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "bidStatus": "{string}", "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "wonCount": "{integer}" }}On Demand Node Pool
OnDemandNodePool APIs
Get all ondemandnodepools
Retrieve all OnDemandNodePools from the specified namespace.
| namespace | string | The namespace to which the OnDemandNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/ondemandnodepools' \ --header 'Authorization: {Authorization}'OnDemandNodePools obtained successfully.
| object | object | OnDemandNodePoolList is a list of OnDemandNodePool | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| items | array[object] | List of ondemandnodepools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | OnDemandNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | OnDemandNodePoolSpec defines the desired state of OnDemandNodePool | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of OnDemandNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of OnDemandNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of OnDemandNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the OnDemandNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | OnDemandNodePoolStatus defines the observed state of OnDemandNodePool | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| reservedCount | integer | Number of reserved servers | |
| reservedStatus | string | Status of reserved servers | |
| kind | string | OnDemandNodePoolList | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
Unauthorized access.
{ "apiVersion": "{string}", "items": [ { "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "reservedCount": "{integer}", "reservedStatus": "{string}" } } ], "kind": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }}Create ondemandnodepool
Create an OnDemandNodePool in the specified namespace.
| namespace | string | The namespace to which the OnDemandNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
Use value for
apiVersionasngpc.rxt.io/v1.Use value for
kindasOnDemandNodePool.In the
metadataobject:Enter a value for the
namefield in themetadataobject to name your OnDemandNodePool. The name must be alowercase UUIDonly.Select the
namespacein which the OnDemandNodePool should be created. This should match thenamespaceused in the path parameter above.creationTimestampanddeletionTimestamp: Represents timestamp for SpotNodePool creation. Leave it as default only.
In the
specobject:cloudSpace: Specify the name of your cloudspace in which SpotNodePool should be created.desired: The desired number of resources (nodes) to be provisioned.serverClass: Specify the Serverclass type for the cloudspace. Refer to Serverclass api for available serverclasses.
| object | object | OnDemandNodePool is the Schema for the ondemandnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | OnDemandNodePool | |
| metadata | object | Additional information | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| spec | object | OnDemandNodePoolSpec defines the desired state of OnDemandNodePool | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| desired | integer | Number of Spot Servers required within the OnDemandNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. |
curl --request POST \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/ondemandnodepools' \ --header 'Authorization: {Authorization}' \ --data '{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "name": "{string}", "namespace": "{string}" }, "spec": { "cloudSpace": "{string}", "desired": "{integer}", "serverClass": "{string}" }}'OnDemandNodePool creation request submitted successfully.
| object | object | OnDemandNodePool is the Schema for the ondemandnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | OnDemandNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | OnDemandNodePoolSpec defines the desired state of OnDemandNodePool | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of OnDemandNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of OnDemandNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of OnDemandNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the OnDemandNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | OnDemandNodePoolStatus defines the observed state of OnDemandNodePool | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| reservedCount | integer | Number of reserved servers | |
| reservedStatus | string | Status of reserved servers |
OnDemandNodePool created successfully.
OnDemandNodePool creation request accepted successfully.
Unauthorized access.
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "reservedCount": "{integer}", "reservedStatus": "{string}" }}Delete all ondemandnodepools
Delete all OnDenamdNodePools from the specified namespace.
| namespace | string | The namespace to which the OnDemandNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --request DELETE \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/ondemandnodepools' \ --header 'Authorization: {Authorization}'OnDemandNodePools deleted successfully.
| object | object | Status is a return value for calls that don't return other objects. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| code | int32 | Suggested HTTP return code for this status, 0 if not set. | |
| details | object | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. | |
| causes | array[object] | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | |
| field | string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items [ 0 ].name" - the field "name" on the first array entry in "items" | |
| message | string | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | |
| reason | string | A machine-readable description of the cause of the error. If this value is empty there is no information available. | |
| group | string | The group attribute of the resource associated with the status StatusReason. | |
| kind | string | ||
| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | |
| retryAfterSeconds | int32 | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | |
| uid | string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| kind | string | Kind of kubernetes resource | |
| message | string | A human-readable description of the status of this operation. | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| reason | string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | |
| status | string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
Unauthorized access.
{ "apiVersion": "{string}", "code": "{int32}", "details": { "causes": [ { "field": "{string}", "message": "{string}", "reason": "{string}" } ], "group": "{string}", "kind": "{string}", "name": "{string}", "retryAfterSeconds": "{int32}", "uid": "{string}" }, "kind": "{string}", "message": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }, "reason": "{string}", "status": "{string}"}On Demand Node Pool By Name
OnDemandNodePool by name APIs
Get ondemandnodepool by name
Retrieves the details of an OnDemandNodePool by its name from the specified namespace.
| name | string | OnDemandNodePool name, must be a lowercase UUID | |
| namespace | string | The namespace to which the OnDemandNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --get \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/ondemandnodepools/{name}' \ --header 'Authorization: {Authorization}'Specific OnDemandNodePool obtained successfully.
| object | object | OnDemandNodePool is the Schema for the ondemandnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | OnDemandNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | OnDemandNodePoolSpec defines the desired state of OnDemandNodePool | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of OnDemandNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of OnDemandNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of OnDemandNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the OnDemandNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | OnDemandNodePoolStatus defines the observed state of OnDemandNodePool | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| reservedCount | integer | Number of reserved servers | |
| reservedStatus | string | Status of reserved servers |
Unauthorized access.
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "reservedCount": "{integer}", "reservedStatus": "{string}" }}Delete ondemandnodepool by name
Delete an OnDemandNodePool by its name from the specified namespace.
| name | string | OnDemandNodePool name, must be a lowercase UUID | |
| namespace | string | The namespace to which the OnDemandNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
curl --request DELETE \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/ondemandnodepools/{name}' \ --header 'Authorization: {Authorization}'Specific OnDemandNodePool deletion request submitted successfully.
| object | object | Status is a return value for calls that don't return other objects. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| code | int32 | Suggested HTTP return code for this status, 0 if not set. | |
| details | object | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. | |
| causes | array[object] | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | |
| field | string | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items [ 0 ].name" - the field "name" on the first array entry in "items" | |
| message | string | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | |
| reason | string | A machine-readable description of the cause of the error. If this value is empty there is no information available. | |
| group | string | The group attribute of the resource associated with the status StatusReason. | |
| kind | string | ||
| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | |
| retryAfterSeconds | int32 | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | |
| uid | string | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| kind | string | Kind of kubernetes resource | |
| message | string | A human-readable description of the status of this operation. | |
| metadata | object | Additional information | |
| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. | |
| remainingItemCount | int64 | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. | |
| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| reason | string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | |
| status | string | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
Specific OnDemandNodePool deletion request accepted successfully.
Unauthorized access.
{ "apiVersion": "{string}", "code": "{int32}", "details": { "causes": [ { "field": "{string}", "message": "{string}", "reason": "{string}" } ], "group": "{string}", "kind": "{string}", "name": "{string}", "retryAfterSeconds": "{int32}", "uid": "{string}" }, "kind": "{string}", "message": "{string}", "metadata": { "continue": "{string}", "remainingItemCount": "{int64}", "resourceVersion": "{string}", "selfLink": "{string}" }, "reason": "{string}", "status": "{string}"}Edit ondemandnodepool by name
Update a OnDemandNodePool by its name from the specified namespace.
| name | string | OnDemandNodePool name, must be a lowercase UUID | |
| namespace | string | The namespace to which the OnDemandNodePool belongs to. Desired namespace value can be obtained by calling api: list of organizations. |
This endpoint allows you to perform operations on the OnDemandNodePool configuration.
op: Represents the operation to be performed.add: Adds a new field or value at the specifiedpathin spec section of object.replace: Replaces the existing value at the specifiedpathin spec section of object.
path: Specifies the location within the object where the operation should be applied.- For example, to add a new field, use /spec/newField.
- To replace an existing field, use /spec/existingField.
value: Represents the data to be added or replaced at the specified path.
| object | object | Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. |
curl --request PATCH \ --url 'https://spot.rackspace.com/apis/ngpc.rxt.io/v1/namespaces/{namespace}/ondemandnodepools/{name}' \ --header 'Authorization: {Authorization}' \ --data '[ { "op": "replace", "path": "/spec/someSpec1", "value": "anotherValue" }, { "op": "add", "path": "/spec/someSpec2", "value": "newValue" }]'OnDemandNodePool updated successfully.
| object | object | OnDemandNodePool is the Schema for the ondemandnodepools API | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| kind | string | OnDemandNodePool | |
| metadata | object | Additional information | |
| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: Annotations. | |
| creationTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| deletionGracePeriodSeconds | int64 | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | |
| deletionTimestamp | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| finalizers | array[string] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| generation | int64 | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | |
| managedFields | array[object] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
| fieldsV1 | object | FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff | |
| manager | string | Manager is an identifier of the workflow managing these fields. | |
| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
| subresource | string | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | |
| time | date-time | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
| name | string | Name of the resource | |
| namespace | string | Organization namespace | |
| ownerReferences | array[object] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
| apiVersion | string | ngpc.rxt.io/v1 | |
| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | |
| controller | boolean | If true, this reference points to the managing controller. | |
| kind | string | kind of resource. | |
| name | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | |
| uid | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
| selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| uid | string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | |
| spec | object | OnDemandNodePoolSpec defines the desired state of OnDemandNodePool | |
| cloudSpace | string | The name of the CloudSpace to which the SpotNodePool resource belongs. A CloudSpace with the given name must exist within the specified namespace. | |
| customAnnotations | object | Custom annotations to be applied to the nodes of OnDemandNodePool | |
| customLabels | object | Custom labels to be applied to the nodes of OnDemandNodePool | |
| customTaints | array[object] | Custom taints to be applied to the nodes of OnDemandNodePool | |
| effect | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | |
| key | string | Required. The taint key to be applied to a node. | |
| timeAdded | date-time | TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
| value | string | The taint value corresponding to the taint key. | |
| desired | integer | Number of Spot Servers required within the OnDemandNodePool. | |
| serverClass | string | ServerClass name for Spot Servers. Must be a valid name from available API: ServerClasses. | |
| status | object | OnDemandNodePoolStatus defines the observed state of OnDemandNodePool | |
| customMetadataStatus | object | CustomMetadataStatus tracks the keys of custom metadata currently applied to nodes | |
| annotations | array[string] | Annotations contains the keys of custom annotations that were applied | |
| labels | array[string] | Labels contains the keys of custom labels that were applied | |
| taints | array[string] | Taints contains the keys of custom taints that were applied | |
| reservedCount | integer | Number of reserved servers | |
| reservedStatus | string | Status of reserved servers |
Unauthorized access.
{ "apiVersion": "{string}", "kind": "{string}", "metadata": { "annotations": {}, "creationTimestamp": "{date-time}", "deletionGracePeriodSeconds": "{int64}", "deletionTimestamp": "{date-time}", "finalizers": [ "{array[string]...}" ], "generateName": "{string}", "generation": "{int64}", "labels": {}, "managedFields": [ { "apiVersion": "{string}", "fieldsType": "{string}", "fieldsV1": {}, "manager": "{string}", "operation": "{string}", "subresource": "{string}", "time": "{date-time}" } ], "name": "{string}", "namespace": "{string}", "ownerReferences": [ { "apiVersion": "{string}", "blockOwnerDeletion": "{boolean}", "controller": "{boolean}", "kind": "{string}", "name": "{string}", "uid": "{string}" } ], "resourceVersion": "{string}", "selfLink": "{string}", "uid": "{string}" }, "spec": { "cloudSpace": "{string}", "customAnnotations": {}, "customLabels": {}, "customTaints": [ { "effect": "{string}", "key": "{string}", "timeAdded": "{date-time}", "value": "{string}" } ], "desired": "{integer}", "serverClass": "{string}" }, "status": { "customMetadataStatus": { "annotations": [ "{array[string]...}" ], "labels": [ "{array[string]...}" ], "taints": [ "{array[string]...}" ] }, "reservedCount": "{integer}", "reservedStatus": "{string}" }}Price History
Price history for a server class APIs
Get price history for a server class (unauthenticated api)
Retrieve historical price data for a given server class.
This api does not require bearerToken for its usage.
Valid server_class values include:
- gp.vs1.medium-dfw
- gp.vs1.small-dfw
- mh.vs1.large-dfw
- mh.vs1.xlarge-dfw
- ch.vs1.medium-dfw
- gp.bm2.large-dfw
- mh.vs1.medium-dfw
- gp.bm2.medium-dfw
- mh.vs1.2xlarge-dfw
- mh.vs1.2xlarge-iad
- gp.vs1.2xlarge-lon
- gp.vs1.xlarge-lon
- ch.vs1.xlarge-iad
- gp.bm2.medium-lon
- ch.vs1.medium-iad
- gp.bm2.small-lon
- ch.vs1.2xlarge-iad
- mh.vs1.xlarge-iad
- mh.vs1.large-iad
- ch.vs1.large-lon
- gp.bm2.large-lon
- mh.vs1.2xlarge-lon
- ch.vs1.large-iad
- gp.bm2.small-iad
- ch.vs1.2xlarge-lon
- ch.vs1.medium-lon
- mh.vs1.medium-lon
- mh.vs1.large-lon
- mh.vs1.xlarge-lon
- gp.vs1.small-iad
- ch.vs1.xlarge-lon
- io.bm2-lon
- io.bm2-iad
- gp.vs1.large-lon
- ch.vs1.2xlarge-dfw
- ch.vs1.xlarge-dfw
- gp.vs1.2xlarge-iad
- mh.vs1.medium-iad
- gp.vs1.large-iad
- gp.vs1.large-dfw
- ch.vs1.large-dfw
- gp.vs1.medium-lon
- gp.vs1.xlarge-dfw
- gp.vs1.medium-iad
- gp.vs1.xlarge-iad
| server | string | Server class name (e.g., |
curl --get \ --url 'https://ngpc-prod-public-data.s3.us-east-2.amazonaws.com/history/{server_class}'A list of historical hammer prices
| object | object | ||
| auction | string | Serverclass type for which the auction was held | |
| history | array[object] | ||
| run | int64 | Unix timestamp of the auction | |
| hammer | number | Final price in USD |
Invalid server class
Unexpected error
{ "auction": "gp.vs1.xlarge-lon", "history": [ { "run_at": "{int64}", "hammer_price": "{number}" } ]}Percentile Information
Percentile Information APIs
Get Percentile Information (unauthenticated api)
Returns percentile data for various server classes. This api does not require bearerToken for its usage.
curl --get \ --url 'https://ngpc-prod-public-data.s3.us-east-2.amazonaws.com/percentiles.json'A list of regions with server pricing details - percentile information
| object | object | ||
| regions | object | ||
| * | object | ||
| generation | string | ||
| serverclasses | object | ||
| * | object | ||
| display | string | ||
| category | string | ||
| description | string | ||
| cpu | string | ||
| memory | string | ||
| market | string | ||
| 20 | number | ||
| 50 | number | ||
| 80 | number |
Unexpected error
{ "regions": {}}Market Price Capacity
Market Price Capacity (Comparable Prices) APIs
Get Market Price Capacity (Comparable Prices) (unauthenticated api)
Returns comparable pricing data. This api does not require bearerToken for its usage.
curl --get \ --url 'https://ngpc-prod-public-data.s3.us-east-2.amazonaws.com/comparable_prices.json'Regions and pricing data retrieved successfully.
| object | object | ||
| regions | object | ||
| * | object | VM instance type mapping in the region. | |
| * | object | ||
| hyperscaler | string | Average hyperscaler price (e.g., AWS, Azure). | |
| comparables | array[object] | Comparable instance types and their prices. | |
| cloud | string | ||
| class | string | ||
| price | string |
Unexpected error
{ "regions": {}}