pnap_rancher_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3e1ebc4f9061db1c418c05fa8b4c1b0fb3e9fe72fb53d6ec755a745ab8513bf
+  data.tar.gz: 18138cc637f6bff2be3c9e74dcd0ee98b8a1b04163e68662ba0c54a6205332a8
+SHA512:
+  metadata.gz: 9f048555f2302b2050964f9cf20a0fbcfcf5e3640ce36b613ba17a6f65d8e61241d01198a896a0b7fa481ba9c361c71fca578b23943a02e4120770948ed90f50
+  data.tar.gz: 48cc63e93d5e501295dfb804e227125c977272f6ceb02ea658c29af8aa8a8a3926f63b150b68467413962ea9a2e6c6714e073b16e780dbb463cf5b858dfa82e9

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,154 @@
+# pnap_rancher_api
+
+RancherApi - the Ruby gem for the Rancher Solution API
+
+Simplify enterprise-grade Kubernetes cluster operations and management with Rancher on Bare Metal Cloud.
+Deploy Kubernetes clusters using a few API calls.<br>
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/rancher-bmc-integration-kubernetes' target='_blank'>here</a>
+</span><br>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/solutions/rancher/v1beta)</b>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_rancher_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_rancher_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_rancher_api-<VERSION>.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pnap_rancher_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_rancher_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'RancherApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_rancher_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'RancherApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pnap_rancher_api'
+
+# Setup authorization
+RancherApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = RancherApi::ClustersApi.new
+
+begin
+  #Cluster list.
+  result = api_instance.clusters_get
+  p result
+rescue RancherApi::ApiError => e
+  puts "Exception when calling ClustersApi->clusters_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_rancher_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+RancherApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/solutions/rancher/v1beta*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*RancherApi::ClustersApi* | [**clusters_get**](docs/ClustersApi.md#clusters_get) | **GET** /clusters | Cluster list.
+*RancherApi::ClustersApi* | [**clusters_id_delete**](docs/ClustersApi.md#clusters_id_delete) | **DELETE** /clusters/{id} | Delete a cluster.
+*RancherApi::ClustersApi* | [**clusters_id_get**](docs/ClustersApi.md#clusters_id_get) | **GET** /clusters/{id} | Retrieve a Cluster
+*RancherApi::ClustersApi* | [**clusters_post**](docs/ClustersApi.md#clusters_post) | **POST** /clusters | Create a Rancher Server Deployment.
+
+
+## Documentation for Models
+
+ - [RancherApi::Cluster](docs/Cluster.md)
+ - [RancherApi::DeleteResult](docs/DeleteResult.md)
+ - [RancherApi::Error](docs/Error.md)
+ - [RancherApi::Node](docs/Node.md)
+ - [RancherApi::NodePool](docs/NodePool.md)
+ - [RancherApi::RancherClusterCertificates](docs/RancherClusterCertificates.md)
+ - [RancherApi::RancherClusterConfig](docs/RancherClusterConfig.md)
+ - [RancherApi::RancherServerMetadata](docs/RancherServerMetadata.md)
+ - [RancherApi::SshConfig](docs/SshConfig.md)
+ - [RancherApi::WorkloadClusterConfig](docs/WorkloadClusterConfig.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - bmc: Grants full access to bmc-api.
+  - bmc.read: Grants read only access to bmc-api.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/Cluster.md

@@ -0,0 +1,36 @@
+# RancherApi::Cluster
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | (Read-only) The Cluster identifier. | [optional][readonly] |
+| **name** | **String** | Cluster name. This field is autogenerated if not provided. | [optional] |
+| **description** | **String** | Cluster description. | [optional] |
+| **location** | **String** | Deployment location. Cannot be changed once a cluster is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
+| **initial_cluster_version** | **String** | (Read-only) The Rancher version that was installed on the cluster during the first creation process. | [optional][readonly] |
+| **node_pools** | [**Array<NodePool>**](NodePool.md) | The node pools associated with the cluster. | [optional] |
+| **configuration** | [**RancherClusterConfig**](RancherClusterConfig.md) |  | [optional] |
+| **metadata** | [**RancherServerMetadata**](RancherServerMetadata.md) |  | [optional][readonly] |
+| **workload_configuration** | [**WorkloadClusterConfig**](WorkloadClusterConfig.md) |  | [optional] |
+| **status_description** | **String** | The cluster status | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::Cluster.new(
+  id: 6047127fed34ecc3ba8402d2,
+  name: Rancher Management Cluster,
+  description: My first Rancher Server Cluster.,
+  location: PHX,
+  initial_cluster_version: v2.5.9,
+  node_pools: null,
+  configuration: null,
+  metadata: null,
+  workload_configuration: null,
+  status_description: Creating
+)
+```
+

data/docs/ClustersApi.md

@@ -0,0 +1,286 @@
+# RancherApi::ClustersApi
+
+All URIs are relative to *https://api.phoenixnap.com/solutions/rancher/v1beta*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clusters_get**](ClustersApi.md#clusters_get) | **GET** /clusters | Cluster list. |
+| [**clusters_id_delete**](ClustersApi.md#clusters_id_delete) | **DELETE** /clusters/{id} | Delete a cluster. |
+| [**clusters_id_get**](ClustersApi.md#clusters_id_get) | **GET** /clusters/{id} | Retrieve a Cluster |
+| [**clusters_post**](ClustersApi.md#clusters_post) | **POST** /clusters | Create a Rancher Server Deployment. |
+
+
+## clusters_get
+
+> <Array<Cluster>> clusters_get
+
+Cluster list.
+
+Cluster list.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_rancher_api'
+# setup authorization
+RancherApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = RancherApi::ClustersApi.new
+
+begin
+  # Cluster list.
+  result = api_instance.clusters_get
+  p result
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_get: #{e}"
+end
+```
+
+#### Using the clusters_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Cluster>>, Integer, Hash)> clusters_get_with_http_info
+
+```ruby
+begin
+  # Cluster list.
+  data, status_code, headers = api_instance.clusters_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Cluster>>
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Cluster&gt;**](Cluster.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## clusters_id_delete
+
+> <DeleteResult> clusters_id_delete(id)
+
+Delete a cluster.
+
+Delete a cluster.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_rancher_api'
+# setup authorization
+RancherApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = RancherApi::ClustersApi.new
+id = '123' # String | The Cluster identifier.
+
+begin
+  # Delete a cluster.
+  result = api_instance.clusters_id_delete(id)
+  p result
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_id_delete: #{e}"
+end
+```
+
+#### Using the clusters_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteResult>, Integer, Hash)> clusters_id_delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete a cluster.
+  data, status_code, headers = api_instance.clusters_id_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteResult>
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Cluster identifier. |  |
+
+### Return type
+
+[**DeleteResult**](DeleteResult.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## clusters_id_get
+
+> <Cluster> clusters_id_get(id)
+
+Retrieve a Cluster
+
+Retrieve a Cluster
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_rancher_api'
+# setup authorization
+RancherApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = RancherApi::ClustersApi.new
+id = '123' # String | The Cluster identifier.
+
+begin
+  # Retrieve a Cluster
+  result = api_instance.clusters_id_get(id)
+  p result
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_id_get: #{e}"
+end
+```
+
+#### Using the clusters_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Cluster>, Integer, Hash)> clusters_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve a Cluster
+  data, status_code, headers = api_instance.clusters_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Cluster>
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Cluster identifier. |  |
+
+### Return type
+
+[**Cluster**](Cluster.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## clusters_post
+
+> <Cluster> clusters_post(opts)
+
+Create a Rancher Server Deployment.
+
+Create a Rancher Server Deployment as described in <a href='https://rancher.com/docs/rancher/v2.5/en/overview/architecture/#rancher-server-architecture' target='_blank'>Rancher Docs Architecture</a>. Rancher Server allows the creation, import and management of multiple Downstream User Kubernetes Clusters. <b>This is not a Downstream User Cluster</b>. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_rancher_api'
+# setup authorization
+RancherApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = RancherApi::ClustersApi.new
+opts = {
+  cluster: RancherApi::Cluster.new({location: 'PHX'}) # Cluster | 
+}
+
+begin
+  # Create a Rancher Server Deployment.
+  result = api_instance.clusters_post(opts)
+  p result
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_post: #{e}"
+end
+```
+
+#### Using the clusters_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Cluster>, Integer, Hash)> clusters_post_with_http_info(opts)
+
+```ruby
+begin
+  # Create a Rancher Server Deployment.
+  data, status_code, headers = api_instance.clusters_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Cluster>
+rescue RancherApi::ApiError => e
+  puts "Error when calling ClustersApi->clusters_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster** | [**Cluster**](Cluster.md) |  | [optional] |
+
+### Return type
+
+[**Cluster**](Cluster.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DeleteResult.md

@@ -0,0 +1,20 @@
+# RancherApi::DeleteResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** | Solution cluster has been deleted. |  |
+| **cluster_id** | **String** | The unique identifier of the solution cluster. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::DeleteResult.new(
+  result: Solution cluster has been deleted.,
+  cluster_id: x78sdkjds879sd7cx8
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# RancherApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. | [readonly] |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/Node.md

@@ -0,0 +1,18 @@
+# RancherApi::Node
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **server_id** | **String** | The server identifier. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::Node.new(
+  server_id: 60b08f04adab617be44068bb
+)
+```
+

data/docs/NodePool.md

@@ -0,0 +1,26 @@
+# RancherApi::NodePool
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the node pool. | [optional] |
+| **node_count** | **Integer** | Number of configured nodes, currently only node counts of 1 and 3 are possible. | [optional] |
+| **server_type** | **String** | Node server type. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`. | [optional][default to 's0.d1.small'] |
+| **ssh_config** | [**SshConfig**](SshConfig.md) |  | [optional] |
+| **nodes** | [**Array<Node>**](Node.md) | (Read-only) The nodes associated with this node pool. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::NodePool.new(
+  name: Rancher Server node pool.,
+  node_count: null,
+  server_type: s0.d1.small,
+  ssh_config: null,
+  nodes: null
+)
+```
+

data/docs/RancherClusterCertificates.md

@@ -0,0 +1,22 @@
+# RancherApi::RancherClusterCertificates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ca_certificate** | **String** | The SSL CA certificate to be used for rancher admin. | [optional] |
+| **certificate** | **String** | The SSL certificate to be used for rancher admin. | [optional] |
+| **certificate_key** | **String** | The SSL certificate key to be used for rancher admin. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::RancherClusterCertificates.new(
+  ca_certificate: null,
+  certificate: null,
+  certificate_key: null
+)
+```
+

data/docs/RancherClusterConfig.md

@@ -0,0 +1,30 @@
+# RancherApi::RancherClusterConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | Shared secret used to join a server or agent to a cluster. | [optional] |
+| **tls_san** | **String** | This maps to ranchers `tls-san`. Add additional hostname or IP as a Subject Alternative Name in the TLS cert. | [optional] |
+| **etcd_snapshot_schedule_cron** | **String** | This maps to ranchers `etcd-snapshot-schedule-cron`. Snapshot interval time in cron spec. eg. every 5 hours ‘0 */5 * * *’. Default: at 12 am/pm | [optional][default to '0 0,12 * * *'] |
+| **etcd_snapshot_retention** | **Integer** | This maps to ranchers `etcd-snapshot-retention`. Number of snapshots to retain. | [optional][default to 5] |
+| **node_taint** | **String** | This maps to ranchers `node-taint`. Registering kubelet with set of taints. By default, server nodes will be schedulable and thus your workloads can get launched on them. If you wish to have a dedicated control plane where no user workloads will run, you can use taints. | [optional] |
+| **cluster_domain** | **String** | This maps to ranchers `cluster-domain`. Cluster Domain. | [optional] |
+| **certificates** | [**RancherClusterCertificates**](RancherClusterCertificates.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::RancherClusterConfig.new(
+  token: gS7SnDnY5st0ryJxMXA7,
+  tls_san: mydomain.com,
+  etcd_snapshot_schedule_cron: 0 0,12 * * *,
+  etcd_snapshot_retention: 5,
+  node_taint: CriticalAddonsOnly=true:NoExecute,
+  cluster_domain: cluster.local,
+  certificates: null
+)
+```
+

data/docs/RancherServerMetadata.md

@@ -0,0 +1,22 @@
+# RancherApi::RancherServerMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The Rancher Server URL. | [optional] |
+| **username** | **String** | The username to use to login to the Rancher Server. This field is returned only as a response to the create cluster request. Make sure to take note or you will not be able to access the server. | [optional] |
+| **password** | **String** | This is the password to be used to login to the Rancher Server. This field is returned only as a response to the create cluster request. Make sure to take note or you will not be able to access the server. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_rancher_api'
+
+instance = RancherApi::RancherServerMetadata.new(
+  url: https://rancher/,
+  username: admin,
+  password: 1234567890abcd!
+)
+```
+