# README
Scaleway's API
This package contains facilities to play with the Scaleway API, it includes the following features:
- dedicated configuration file containing credentials to deal with the API
- caching to resolve UUIDs without contacting the API
Links
- API documentation
- Official Python SDK
- Projects using this SDK
- https://github.com/scaleway/devhub
- https://github.com/scaleway/docker-machine-driver-scaleway
- https://github.com/scaleway-community/scaleway-ubuntu-coreos/blob/master/overlay/usr/local/update-firewall/scw-api/cache.go
- https://github.com/pulcy/quark
- https://github.com/hex-sh/terraform-provider-scaleway
- https://github.com/tscolari/bosh-scaleway-cpi
- Other golang clients
# Functions
CreateServer creates a server using API based on typical server fields.
CreateVolumeFromHumanSize creates a volume on the API with a human readable size.
FilterImagesByArch removes entry that doesn't match with architecture.
FilterImagesByRegion removes entry that doesn't match with region.
GetIdentifier returns a an identifier if the resolved needles only match one element, else, it exists the program.
InspectIdentifiers inspects identifiers concurrently.
NewDefaultLogger returns a logger which is configured for stdout.
NewDisableLogger returns a logger which is configured to do nothing.
NewScalewayAPI creates a ready-to-use ScalewayAPI client.
NewScalewayCache loads a per-user cache.
NewScalewayResolverResult returns a new ScalewayResolverResult.
ResolveGateway tries to resolve a server public ip address, else returns the input string, i.e.
ResolveIdentifier resolves needle provided by the user.
ResolveIdentifiers resolves needles provided by the user.
StartServer start a server based on its needle, can optionaly block while server is booting.
StartServerOnce wraps StartServer for golang channel.
WaitForServerReady wait for a server state to be running, then wait for the SSH port to be available.
WaitForServerState asks API in a loop until a server matches a wanted state.
WaitForServerStopped wait for a server state to be stopped.
# Constants
CacheArch permits to access at the arch field.
CacheMarketPlaceUUID is used to determine the UUID of local images.
CacheMaxfield is used to determine the size of array.
CacheOwner permits to access at the owner field.
CacheRegion permits to access at the region field.
CacheTitle permits to access at the title field.
IdentifierBootscript is the type key of cached bootscript objects.
IdentifierImage is the type key of cached image objects.
IdentifierServer is the type key of cached server objects.
IdentifierSnapshot is the type key of cached snapshot objects.
IdentifierUnknown is used when we don't know explicitly the type key of the object (used for nil comparison).
IdentifierVolume is the type key of cached volume objects.
# Variables
Default values.
Default values.
Default values.
FuncMap used for json inspection.
Default values.
Default values.
Default values.
Default values.
# Structs
ConfigCreateServer represents the options sent to CreateServer and defining a server.
InspectIdentifierResult is returned by `InspectIdentifiers` and contains the inspected `Object` with its `Type`.
MarketImage represents MarketPlace image.
MarketImages represents MarketPlace images.
MarketLocalImage represents local image.
MarketLocalImageDefinition represents localImage of marketplace version.
MarketLocalImages represents an array of local images.
MarketVersion represents version of marketplace image.
MarketVersionDefinition represents version of marketplace image.
MarketVersions represents an array of marketplace image versions.
ScalewayAPI is the interface used to communicate with the Scaleway API.
ScalewayAPIError represents a Scaleway API Error.
ScalewayBootscript represents a Scaleway Bootscript.
ScalewayBootscripts represents a group of Scaleway bootscripts.
ScalewayCache is used not to query the API to resolve full identifiers.
ScalewayConnect represents the data to connect.
ScalewayConnectResponse represents the answer from POST /tokens.
ScalewayContainer represents a Scaleway container (S3).
ScalewayContainerData represents a Scaleway container data (S3).
ScalewayDashboard represents a dashboard.
ScalewayDashboardResp represents a dashboard received from the API.
ScalewayGetContainerDatas represents a list of Scaleway containers data (S3).
ScalewayGetContainers represents a list of Scaleway containers (S3).
ScalewayGetIP represents the response of a GET /ips/{id_ip}.
ScalewayGetIPS represents the response of a GET /ips/.
ScalewayGetQuotas represents the response of GET /organizations/{orga_id}/quotas.
ScalewayGetSecurityGroup represents the response of a GET /security_groups/{groupID}.
ScalewayGetSecurityGroupRule represents the response of a GET /security_group/{groupID}/rules/{ruleID}.
ScalewayGetSecurityGroupRules represents the response of a GET /security_group/{groupID}/rules.
ScalewayGetSecurityGroups represents the response of a GET /security_groups/.
ScalewayGetTokens represents a list of Scaleway Tokens.
ScalewayImage represents a Scaleway Image.
ScalewayImageDefinition represents a Scaleway image definition.
ScalewayImageIdentifier represents a Scaleway Image Identifier.
ScalewayImageInterface is an interface to multiple Scaleway items.
ScalewayImages represents a group of Scaleway images.
ScalewayIPAddress represents a Scaleway IP address.
ScalewayIPDefinition represents the IP's fields.
ScalewayIPV6Definition represents a Scaleway ipv6.
ScalewayKeyDefinition represents a key.
ScalewayNewSecurityGroup definition POST request /security_groups.
ScalewayNewSecurityGroupRule definition POST/PUT request /security_group/{groupID}.
ScalewayOneBootscript represents the response of a GET /bootscripts/UUID API call.
ScalewayOneImage represents the response of a GET /images/UUID API call.
ScalewayOneServer represents the response of a GET /servers/UUID API call.
ScalewayOneSnapshot represents the response of a GET /snapshots/UUID API call.
ScalewayOneTask represents the response of a GET /tasks/UUID API call.
ScalewayOneVolume represents the response of a GET /volumes/UUID API call.
ScalewayOrganizationDefinition represents a Scaleway Organization.
ScalewayOrganizationsDefinition represents a Scaleway Organizations.
ScalewayPermissionDefinition represents the permissions.
ScalewayResolvedIdentifier represents a list of matching identifier for a specifier pattern.
ScalewayResolverResult is a structure containing human-readable information about resolver results.
ScalewayRoleDefinition represents a Scaleway Token UserId Role.
ScalewaySecurityGroup represents a Scaleway security group.
ScalewaySecurityGroupRule definition.
ScalewaySecurityGroups definition.
ScalewayServer represents a Scaleway server.
ScalewayServerAction represents an action to perform on a Scaleway server.
ScalewayServerDefinition represents a Scaleway server with image definition.
ScalewayServerPatchDefinition represents a Scaleway server with nullable fields (for PATCH).
ScalewayServers represents a group of Scaleway servers.
ScalewaySnapshot represents a Scaleway Snapshot.
ScalewaySnapshotDefinition represents a Scaleway snapshot definition.
ScalewaySnapshots represents a group of Scaleway snapshots.
ScalewayTask represents a Scaleway Task.
ScalewayTasks represents a group of Scaleway tasks.
ScalewayTokenDefinition represents a Scaleway Token.
ScalewayTokensDefinition represents a Scaleway Tokens.
ScalewayUpdateSecurityGroup definition PUT request /security_groups.
ScalewayUserdatas represents the response of a GET /user_data.
ScalewayUserDefinition represents a Scaleway User.
ScalewayUserPatchSSHKeyDefinition represents a User Patch.
ScalewayUsersDefinition represents the response of a GET /user.
ScalewayVolume represents a Scaleway Volume.
ScalewayVolumeDefinition represents a Scaleway volume definition.
ScalewayVolumePutDefinition represents a Scaleway volume with nullable fields (for PUT).
ScalewayVolumes represents a group of Scaleway volumes.
# Interfaces
Logger handles logging concerns for the Scaleway API SDK.
# Type aliases
ByCreationDate sorts images by CreationDate field.
ScalewayPermCategory represents ScalewayPermissions's fields.
ScalewayPermissions represents the response of GET /permissions.
ScalewayQuota represents a map of quota (name, value).
ScalewayResolverResults is a list of `ScalewayResolverResult`.
ScalewaySortServers represents a wrapper to sort by CreationDate the servers.
ScalewayUserdata represents []byte.