531 lines
21 KiB
PHP
531 lines
21 KiB
PHP
<?php
|
|
/**
|
|
* Configuration
|
|
* PHP version 7.4
|
|
*
|
|
* @category Class
|
|
* @package OpenAPI\Client
|
|
* @author OpenAPI Generator team
|
|
* @link https://openapi-generator.tech
|
|
*/
|
|
|
|
/**
|
|
* Public Gateways API
|
|
*
|
|
* Scaleway Public Gateways are building blocks for your infrastructure on Scaleway's public cloud. They sit at the border of Private Networks and provide access to/from other networks or the Internet. As well as this, Public Gateways offer a host of managed features and services to facilitate the management of resources in your Private Network, including NAT to map private IP addresses in the Private Network to the public IP address of the Public Gateway. (switchcolumn) <Message type=\"tip\"> To create and manage your Private Networks, check out the [VPC API](https://www.scaleway.com/en/developers/api/vpc). </Message> (switchcolumn) ## Concepts Refer to our [dedicated concepts page](https://www.scaleway.com/en/docs/public-gateways/concepts/) to find definitions of all terminology related to Public Gateways, including NAT, SSH bastion and more. (switchcolumn) (switchcolumn) ## Quickstart 1. Configure your environment variables. <Message type=\"note\"> This is an optional step that seeks to simplify your usage of the Public Gateways API. </Message> ```bash export SCW_SECRET_KEY=\"<API secret key>\" export SCW_DEFAULT_ZONE=\"<Scaleway default Availability Zone>\" export SCW_PROJECT_ID=\"<Scaleway Project ID>\" ``` 2. **Choose a Public Gateway type**: Public Gateways come in different shapes and sizes, with different network capabilities and pricing. When you create your Public Gateway, you need to include the required Public Gateway type in the request. Use the following call to get a list of available Public Gateway offer types and their details: ```bash curl -X GET \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/vpc-gw/v2/zones/$SCW_DEFAULT_ZONE/gateway-types\" ``` 3. **Create a Public Gateway**: run the following command to create a Public Gateway. You can customize the details in the payload (name, description, tags, etc) to your needs: use the information below to adjust the payload as necessary. ```bash curl -X POST \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/vpc-gw/v2/zones/$SCW_DEFAULT_ZONE/gateways\" \\ -d '{ \"type\": \"VPC-GW-S\", \"name\": \"my-new-gateway\", \"tags\": [\"my-first-tag\", \"my-second-tag\"], \"project_id\": \"'\"$SCW_PROJECT_ID\"'\" }' ``` | Parameter | Description | Valid values | |-----------------|-----------------------------------------------------|-------------------------------| | type | The type of Public Gateway (commercial offer type) to create. Use the Gateway Types endpoint to get a list of offer types. | Any valid offer type string, e.g. `VPC-GW-S` | | name | A name of your choice for the Public Gateway | Any string containing only alphanumeric characters and dashes, e.g. `my-new-gateway`. | | tags | A list of tags to describe your Public Gateway. These can help you manage and filter your gateways. | A list of alphanumeric strings, e.g. `[\"my-first-tag`, `my-second-tag` | | project_id | The Scaleway Project ID to create the Public Gateway in. | A valid Scaleway Project ID, e.g. `f5fe13a0-b9c7-11ed-afa1-0242ac120002` | **Note**: Further parameters are available, but for the purposes of this quickstart we have included only the essentials. See the `Create a Public Gateway` endpoint documentation below for full details of all possible parameters. 4. **Get a list of your Public Gateways**: run the following command to get a list of all your Public Gateways. ```bash curl -X GET \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/vpc-gw/v2/zones/$SCW_DEFAULT_ZONE/gateways\" ``` 5. **Attach a Private Network to a Public Gateway**: run the following command to attach a Private Network to your Public Gateway, and make all the Gateway's services such as NAT available to the Private Network. You can customize the details in the payload to your needs: use the information below to adjust the payload as necessary. <Message type=\"tip\"> If you haven't created a Private Network yet, see the [Private Networks](https://www/scaleway.com/en/developers/api/vpc/) documentation to learn how to do so. Ensure you retain the ID of the Private Network. </Message> ```bash curl -X POST \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/vpc-gw/v2/zones/$SCW_DEFAULT_ZONE/gateway-networks\" \\ -d '{ \"gateway_id\": \"b1b2edda-9364-422d-93f2-ad04e6a054dc\", \"private_network_id\": \"548dbcc3-8b78-486f-a79a-c3f5a17642f9\", \"enable_masquerade\": true }' ``` This configuration will set up the Public Gateway as a NAT gateway, masquerading traffic sent to it to the outer internet to provide internet access to resources in the Private Network. | Parameter | Description | Valid values | |-----------------|-----------------------------------------------------|-------------------------------| | gateway_id | The Public Gateway ID of an existing Public Gateway | Any valid Public Gateway ID, e.g. `b1b2edda-9364-422d-93f2-ad04e6a054dc` | | private_network_id | The Private Network ID of an existing Private Network | Any valid Private Network ID in the same Availability Zone as the Public Gateway, e.g. `548dbcc3-8b78-486f-a79a-c3f5a17642f9` | | enable_masquerade | Defines whether the gateway should masquerade traffic for the attached Private Network (i.e. whether to enable dynamic NAT) | A boolean value, e.g. `true` | <Message type=\"note\"> Further parameters are available, but for the purposes of this quickstart we have included only the essentials. See the [Attach a gateway to a Private Network](#path-gateway-networks-attach-a-public-gateway-to-a-private-network) documentation below for full details of all possible parameters. </Message> 6. **Delete a Public Gateway**: run the following call to delete your Public Gateway. Ensure that you replace `<PUBLIC-GATEWAY-ID>` in the URL with the ID of the Public Gateway you want to delete. ```bash curl -X DELETE \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/vpc-gw/v2/zones/$SCW_DEFAULT_ZONE/gateways/<PUBLIC-GATEWAY-ID>\" ``` The expected successful response is empty. (switchcolumn) <Message type=\"requirement\"> - You have a [Scaleway account](https://console.scaleway.com/) - You have [created an API key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/iam/reference-content/permission-sets/) to perform the actions described on this page - You have [installed `curl`](https://curl.se/download.html) </Message> (switchcolumn) ## Technical limitations The following limitations apply to Public Gateways: - A maximum of eight (8) Private Networks can be plugged into a single Public Gateway - Note that the Public Gateway takes some time to start up, and actions on it are impossible unless it is in the `running` state. To check the current state of a Public Gateway, use the [Get a Public Gateway](#path-gateways-get-a-public-gateway) endpoint to get information for your gateway: the `status` field of the response will tell you if it is running or in another state. - For further information about Public Gateway limitations see our [dedicated documentation](https://www.scaleway.com/en/docs/public-gateways/troubleshooting/gw-limitations/). ## Technical information ### Availability Zones Public Gateways can be deployed in the following Availability Zones: | Name | API ID | |-----------|-----------------------| | Paris | `fr-par-1` `fr-par-2` | | Amsterdam | `nl-ams-1` `nl-ams-2` `nl-ams-3` | | Warsaw | `pl-waw-1` `pl-waw-2` `pl-waw-3` | The Scaleway Public Gateways API is a **zoned** API, meaning that each call must specify in its path parameters the Availability Zone for the resources concerned by the call. ## Going further For more help using Scaleway Public Gateways, check out the following resources: - Our [main documentation](https://www.scaleway.com/en/docs/public-gateways/) - The #public-gateway channel on our [Slack Community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/) - Our [support ticketing system](https://www.scaleway.com/en/docs/account/how-to/open-a-support-ticket/).
|
|
*
|
|
* The version of the OpenAPI document: v2
|
|
* Generated by: https://openapi-generator.tech
|
|
* Generator version: 7.11.0
|
|
*/
|
|
|
|
/**
|
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
namespace OpenAPI\Client;
|
|
|
|
/**
|
|
* Configuration Class Doc Comment
|
|
* PHP version 7.4
|
|
*
|
|
* @category Class
|
|
* @package OpenAPI\Client
|
|
* @author OpenAPI Generator team
|
|
* @link https://openapi-generator.tech
|
|
*/
|
|
class Configuration
|
|
{
|
|
public const BOOLEAN_FORMAT_INT = 'int';
|
|
public const BOOLEAN_FORMAT_STRING = 'string';
|
|
|
|
/**
|
|
* @var Configuration
|
|
*/
|
|
private static $defaultConfiguration;
|
|
|
|
/**
|
|
* Associate array to store API key(s)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected $apiKeys = [];
|
|
|
|
/**
|
|
* Associate array to store API prefix (e.g. Bearer)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected $apiKeyPrefixes = [];
|
|
|
|
/**
|
|
* Access token for OAuth/Bearer authentication
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $accessToken = '';
|
|
|
|
/**
|
|
* Boolean format for query string
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $booleanFormatForQueryString = self::BOOLEAN_FORMAT_INT;
|
|
|
|
/**
|
|
* Username for HTTP basic authentication
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $username = '';
|
|
|
|
/**
|
|
* Password for HTTP basic authentication
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $password = '';
|
|
|
|
/**
|
|
* The host
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $host = 'https://api.scaleway.com';
|
|
|
|
/**
|
|
* User agent of the HTTP request, set to "OpenAPI-Generator/{version}/PHP" by default
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $userAgent = 'OpenAPI-Generator/1.0.0/PHP';
|
|
|
|
/**
|
|
* Debug switch (default set to false)
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $debug = false;
|
|
|
|
/**
|
|
* Debug file location (log to STDOUT by default)
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $debugFile = 'php://output';
|
|
|
|
/**
|
|
* Debug file location (log to STDOUT by default)
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $tempFolderPath;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->tempFolderPath = sys_get_temp_dir();
|
|
}
|
|
|
|
/**
|
|
* Sets API key
|
|
*
|
|
* @param string $apiKeyIdentifier API key identifier (authentication scheme)
|
|
* @param string $key API key or token
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setApiKey($apiKeyIdentifier, $key)
|
|
{
|
|
$this->apiKeys[$apiKeyIdentifier] = $key;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets API key
|
|
*
|
|
* @param string $apiKeyIdentifier API key identifier (authentication scheme)
|
|
*
|
|
* @return null|string API key or token
|
|
*/
|
|
public function getApiKey($apiKeyIdentifier)
|
|
{
|
|
return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null;
|
|
}
|
|
|
|
/**
|
|
* Sets the prefix for API key (e.g. Bearer)
|
|
*
|
|
* @param string $apiKeyIdentifier API key identifier (authentication scheme)
|
|
* @param string $prefix API key prefix, e.g. Bearer
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setApiKeyPrefix($apiKeyIdentifier, $prefix)
|
|
{
|
|
$this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets API key prefix
|
|
*
|
|
* @param string $apiKeyIdentifier API key identifier (authentication scheme)
|
|
*
|
|
* @return null|string
|
|
*/
|
|
public function getApiKeyPrefix($apiKeyIdentifier)
|
|
{
|
|
return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null;
|
|
}
|
|
|
|
/**
|
|
* Sets the access token for OAuth
|
|
*
|
|
* @param string $accessToken Token for OAuth
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setAccessToken($accessToken)
|
|
{
|
|
$this->accessToken = $accessToken;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the access token for OAuth
|
|
*
|
|
* @return string Access token for OAuth
|
|
*/
|
|
public function getAccessToken()
|
|
{
|
|
return $this->accessToken;
|
|
}
|
|
|
|
/**
|
|
* Sets boolean format for query string.
|
|
*
|
|
* @param string $booleanFormat Boolean format for query string
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setBooleanFormatForQueryString(string $booleanFormat)
|
|
{
|
|
$this->booleanFormatForQueryString = $booleanFormat;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets boolean format for query string.
|
|
*
|
|
* @return string Boolean format for query string
|
|
*/
|
|
public function getBooleanFormatForQueryString(): string
|
|
{
|
|
return $this->booleanFormatForQueryString;
|
|
}
|
|
|
|
/**
|
|
* Sets the username for HTTP basic authentication
|
|
*
|
|
* @param string $username Username for HTTP basic authentication
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setUsername($username)
|
|
{
|
|
$this->username = $username;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the username for HTTP basic authentication
|
|
*
|
|
* @return string Username for HTTP basic authentication
|
|
*/
|
|
public function getUsername()
|
|
{
|
|
return $this->username;
|
|
}
|
|
|
|
/**
|
|
* Sets the password for HTTP basic authentication
|
|
*
|
|
* @param string $password Password for HTTP basic authentication
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setPassword($password)
|
|
{
|
|
$this->password = $password;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the password for HTTP basic authentication
|
|
*
|
|
* @return string Password for HTTP basic authentication
|
|
*/
|
|
public function getPassword()
|
|
{
|
|
return $this->password;
|
|
}
|
|
|
|
/**
|
|
* Sets the host
|
|
*
|
|
* @param string $host Host
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setHost($host)
|
|
{
|
|
$this->host = $host;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the host
|
|
*
|
|
* @return string Host
|
|
*/
|
|
public function getHost()
|
|
{
|
|
return $this->host;
|
|
}
|
|
|
|
/**
|
|
* Sets the user agent of the api client
|
|
*
|
|
* @param string $userAgent the user agent of the api client
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return $this
|
|
*/
|
|
public function setUserAgent($userAgent)
|
|
{
|
|
if (!is_string($userAgent)) {
|
|
throw new \InvalidArgumentException('User-agent must be a string.');
|
|
}
|
|
|
|
$this->userAgent = $userAgent;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the user agent of the api client
|
|
*
|
|
* @return string user agent
|
|
*/
|
|
public function getUserAgent()
|
|
{
|
|
return $this->userAgent;
|
|
}
|
|
|
|
/**
|
|
* Sets debug flag
|
|
*
|
|
* @param bool $debug Debug flag
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setDebug($debug)
|
|
{
|
|
$this->debug = $debug;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the debug flag
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getDebug()
|
|
{
|
|
return $this->debug;
|
|
}
|
|
|
|
/**
|
|
* Sets the debug file
|
|
*
|
|
* @param string $debugFile Debug file
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setDebugFile($debugFile)
|
|
{
|
|
$this->debugFile = $debugFile;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the debug file
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDebugFile()
|
|
{
|
|
return $this->debugFile;
|
|
}
|
|
|
|
/**
|
|
* Sets the temp folder path
|
|
*
|
|
* @param string $tempFolderPath Temp folder path
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setTempFolderPath($tempFolderPath)
|
|
{
|
|
$this->tempFolderPath = $tempFolderPath;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the temp folder path
|
|
*
|
|
* @return string Temp folder path
|
|
*/
|
|
public function getTempFolderPath()
|
|
{
|
|
return $this->tempFolderPath;
|
|
}
|
|
|
|
/**
|
|
* Gets the default configuration instance
|
|
*
|
|
* @return Configuration
|
|
*/
|
|
public static function getDefaultConfiguration()
|
|
{
|
|
if (self::$defaultConfiguration === null) {
|
|
self::$defaultConfiguration = new Configuration();
|
|
}
|
|
|
|
return self::$defaultConfiguration;
|
|
}
|
|
|
|
/**
|
|
* Sets the default configuration instance
|
|
*
|
|
* @param Configuration $config An instance of the Configuration Object
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function setDefaultConfiguration(Configuration $config)
|
|
{
|
|
self::$defaultConfiguration = $config;
|
|
}
|
|
|
|
/**
|
|
* Gets the essential information for debugging
|
|
*
|
|
* @return string The report for debugging
|
|
*/
|
|
public static function toDebugReport()
|
|
{
|
|
$report = 'PHP SDK (OpenAPI\Client) Debug Report:' . PHP_EOL;
|
|
$report .= ' OS: ' . php_uname() . PHP_EOL;
|
|
$report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
|
|
$report .= ' The version of the OpenAPI document: v2' . PHP_EOL;
|
|
$report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
|
|
|
|
return $report;
|
|
}
|
|
|
|
/**
|
|
* Get API key (with prefix if set)
|
|
*
|
|
* @param string $apiKeyIdentifier name of apikey
|
|
*
|
|
* @return null|string API key with the prefix
|
|
*/
|
|
public function getApiKeyWithPrefix($apiKeyIdentifier)
|
|
{
|
|
$prefix = $this->getApiKeyPrefix($apiKeyIdentifier);
|
|
$apiKey = $this->getApiKey($apiKeyIdentifier);
|
|
|
|
if ($apiKey === null) {
|
|
return null;
|
|
}
|
|
|
|
if ($prefix === null) {
|
|
$keyWithPrefix = $apiKey;
|
|
} else {
|
|
$keyWithPrefix = $prefix . ' ' . $apiKey;
|
|
}
|
|
|
|
return $keyWithPrefix;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of host settings
|
|
*
|
|
* @return array an array of host settings
|
|
*/
|
|
public function getHostSettings()
|
|
{
|
|
return [
|
|
[
|
|
"url" => "https://api.scaleway.com",
|
|
"description" => "No description provided",
|
|
]
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns URL based on host settings, index and variables
|
|
*
|
|
* @param array $hostSettings array of host settings, generated from getHostSettings() or equivalent from the API clients
|
|
* @param int $hostIndex index of the host settings
|
|
* @param array|null $variables hash of variable and the corresponding value (optional)
|
|
* @return string URL based on host settings
|
|
*/
|
|
public static function getHostString(array $hostSettings, $hostIndex, ?array $variables = null)
|
|
{
|
|
if (null === $variables) {
|
|
$variables = [];
|
|
}
|
|
|
|
// check array index out of bound
|
|
if ($hostIndex < 0 || $hostIndex >= count($hostSettings)) {
|
|
throw new \InvalidArgumentException("Invalid index $hostIndex when selecting the host. Must be less than ".count($hostSettings));
|
|
}
|
|
|
|
$host = $hostSettings[$hostIndex];
|
|
$url = $host["url"];
|
|
|
|
// go through variable and assign a value
|
|
foreach ($host["variables"] ?? [] as $name => $variable) {
|
|
if (array_key_exists($name, $variables)) { // check to see if it's in the variables provided by the user
|
|
if (!isset($variable['enum_values']) || in_array($variables[$name], $variable["enum_values"], true)) { // check to see if the value is in the enum
|
|
$url = str_replace("{".$name."}", $variables[$name], $url);
|
|
} else {
|
|
throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].". Must be ".join(',', $variable["enum_values"]).".");
|
|
}
|
|
} else {
|
|
// use default value
|
|
$url = str_replace("{".$name."}", $variable["default_value"], $url);
|
|
}
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Returns URL based on the index and variables
|
|
*
|
|
* @param int $index index of the host settings
|
|
* @param array|null $variables hash of variable and the corresponding value (optional)
|
|
* @return string URL based on host settings
|
|
*/
|
|
public function getHostFromSettings($index, $variables = null)
|
|
{
|
|
return self::getHostString($this->getHostSettings(), $index, $variables);
|
|
}
|
|
}
|