Update Lego
This commit is contained in:
Ludovic Fernandez
Traefiker Bot
parent
36966da701
commit
253060b4f3
185 changed files with 16653 additions and 3210 deletions
178
vendor/github.com/exoscale/egoscale/doc.go
generated
vendored
178
vendor/github.com/exoscale/egoscale/doc.go
generated
vendored
|
|
@ -1,16 +1,76 @@
|
|||
/*
|
||||
|
||||
Package egoscale is a mapping for with the CloudStack API (http://cloudstack.apache.org/api.html) from Go. It has been designed against the Exoscale (https://www.exoscale.ch/) infrastructure but should fit other CloudStack services.
|
||||
Package egoscale is a mapping for with the CloudStack API (http://cloudstack.apache.org/api.html) from Go. It has been designed against the Exoscale (https://www.exoscale.com/) infrastructure but should fit other CloudStack services.
|
||||
|
||||
Requests and Responses
|
||||
|
||||
The paradigm used in this library is that CloudStack defines two types of requests synchronous (client.Request) and asynchronous (client.AsyncRequest). And when the expected responses is a success message, you may use the boolean requests variants (client.BooleanRequest, client.BooleanAsyncRequest). To build a request, construct the adequate struct. This library expects a pointer for efficiency reasons only. The response is a struct corresponding to the request itself. E.g. DeployVirtualMachine gives DeployVirtualMachineResponse, as a pointer as well to avoid big copies.
|
||||
To build a request, construct the adequate struct. This library expects a pointer for efficiency reasons only. The response is a struct corresponding to the data at stake. E.g. DeployVirtualMachine gives a VirtualMachine, as a pointer as well to avoid big copies.
|
||||
|
||||
Then everything within the struct is not a pointer.
|
||||
Then everything within the struct is not a pointer. Find below some examples of how egoscale may be used to interact with a CloudStack endpoint, especially Exoscale itself. If anything feels odd or unclear, please let us know: https://github.com/exoscale/egoscale/issues
|
||||
|
||||
Affinity and Anti-Affinity groups
|
||||
req := &egoscale.DeployVirtualMachine{
|
||||
Size: 10,
|
||||
ServiceOfferingID: "...",
|
||||
TemplateID: "...",
|
||||
ZoneID: "...",
|
||||
}
|
||||
|
||||
fmt.Println("Deployment started")
|
||||
resp, err := cs.Request(req)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
vm := resp.(*egoscale.VirtualMachine)
|
||||
fmt.Printf("Virtual Machine ID: %s\n", vm.ID)
|
||||
|
||||
This example deploys a virtual machine while controlling the job status as it goes. It enables a finer control over errors, e.g. HTTP timeout, and eventually a way to kill it of (from the client side).
|
||||
|
||||
req := &egoscale.DeployVirtualMachine{
|
||||
Size: 10,
|
||||
ServiceOfferingID: "...",
|
||||
TemplateID: "...",
|
||||
ZoneID: "...",
|
||||
}
|
||||
vm := &egoscale.VirtualMachine{}
|
||||
|
||||
fmt.Println("Deployment started")
|
||||
cs.AsyncRequest(req, func(jobResult *egoscale.AsyncJobResult, err error) bool {
|
||||
if err != nil {
|
||||
// any kind of error
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Keep waiting
|
||||
if jobResult.JobStatus == egoscale.Pending {
|
||||
fmt.Println("wait...")
|
||||
return true
|
||||
}
|
||||
|
||||
// Unmarshal the response into the response struct
|
||||
if err := jobResult.Response(vm); err != nil {
|
||||
// JSON unmarshaling error
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Stop waiting
|
||||
return false
|
||||
})
|
||||
|
||||
fmt.Printf("Virtual Machine ID: %s\n", vm.ID)
|
||||
|
||||
Debugging and traces
|
||||
|
||||
As this library is mostly an HTTP client, you can reuse all the existing tools around it.
|
||||
|
||||
cs := egoscale.NewClient("https://api.exoscale.ch/compute", "EXO...", "...")
|
||||
// sets a logger on stderr
|
||||
cs.Logger = log.Newos.Stderr, "prefix", log.LstdFlags)
|
||||
// activates the HTTP traces
|
||||
cs.TraceOn()
|
||||
|
||||
Nota bene: when running the tests or the egoscale library via another tool, e.g. the exo cli (or the cs cli), the environment variable EXOSCALE_TRACE=prefix does the above configuration for you. As a developer using egoscale as a library, you'll find it more convenient to plug your favorite io.Writer as it's Logger.
|
||||
|
||||
Affinity and Anti-Affinity groups provide a way to influence where VMs should run. See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/stable/virtual_machines.html#affinity-groups
|
||||
|
||||
APIs
|
||||
|
||||
|
|
@ -24,70 +84,94 @@ All the available APIs on the server and provided by the API Discovery plugin
|
|||
}
|
||||
|
||||
for _, api := range resp.(*egoscale.ListAPIsResponse).API {
|
||||
fmt.Println("%s %s", api.Name, api.Description)
|
||||
fmt.Printf("%s %s\n", api.Name, api.Description)
|
||||
}
|
||||
// Output:
|
||||
// listNetworks Lists all available networks
|
||||
// ...
|
||||
|
||||
|
||||
Elastic IPs
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/networking_and_traffic.html#about-elastic-ips
|
||||
|
||||
Networks
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/4.8/networking_and_traffic.html
|
||||
|
||||
NICs
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/networking_and_traffic.html#configuring-multiple-ip-addresses-on-a-single-nic
|
||||
|
||||
|
||||
Security Groups
|
||||
|
||||
Security Groups provide a way to isolate traffic to VMs.
|
||||
Security Groups provide a way to isolate traffic to VMs. Rules are added via the two Authorization commands.
|
||||
|
||||
resp, err := cs.Request(&egoscale.CreateSecurityGroup{
|
||||
Name: "Load balancer",
|
||||
Description: "Opens HTTP/HTTPS ports from the outside world",
|
||||
})
|
||||
securityGroup := resp.(*egoscale.CreateSecurityGroupResponse).SecurityGroup
|
||||
securityGroup := resp.(*egoscale.SecurityGroup)
|
||||
|
||||
resp, err = cs.Request(&egoscale.AuthorizeSecurityGroupIngress{
|
||||
Description: "SSH traffic",
|
||||
SecurityGroupID: securityGroup.ID,
|
||||
CidrList: []string{"0.0.0.0/0"},
|
||||
Protocol: "tcp",
|
||||
StartPort: 22,
|
||||
EndPort: 22,
|
||||
})
|
||||
// The modified SecurityGroup is returned
|
||||
securityGroup := resp.(*egoscale.SecurityGroup)
|
||||
|
||||
// ...
|
||||
err = client.BooleanRequest(&egoscale.DeleteSecurityGroup{
|
||||
ID: securityGroup.ID,
|
||||
})
|
||||
// ...
|
||||
|
||||
Security Group also implement the generic List, Get and Delete interfaces (Listable, Gettable and Deletable).
|
||||
|
||||
// List all Security Groups
|
||||
sgs, err := cs.List(new(egoscale.SecurityGroup))
|
||||
for _, s := range sgs {
|
||||
sg := s.(egoscale.SecurityGroup)
|
||||
// ...
|
||||
}
|
||||
|
||||
// Get a Security Group
|
||||
sg := &egoscale.SecurityGroup{Name: "Load balancer"}
|
||||
if err := cs.Get(sg); err != nil {
|
||||
...
|
||||
}
|
||||
// The SecurityGroup struct has been loaded with the SecurityGroup informations
|
||||
|
||||
if err := cs.Delete(sg); err != nil {
|
||||
...
|
||||
}
|
||||
// The SecurityGroup has been deleted
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/stable/networking_and_traffic.html#security-groups
|
||||
|
||||
Service Offerings
|
||||
|
||||
A service offering correspond to some hardware features (CPU, RAM).
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/service_offerings.html
|
||||
|
||||
SSH Key Pairs
|
||||
|
||||
In addition to username and password (disabled on Exoscale), SSH keys are used to log into the infrastructure.
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/stable/virtual_machines.html#creating-the-ssh-keypair
|
||||
|
||||
Virtual Machines
|
||||
|
||||
... todo ...
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/stable/virtual_machines.html
|
||||
|
||||
Templates
|
||||
|
||||
... todo ...
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/templates.html
|
||||
|
||||
Zones
|
||||
|
||||
A Zone corresponds to a Data Center.
|
||||
A Zone corresponds to a Data Center. You may list them. Zone implements the Listable interface, which let you perform a list in two different ways. The first exposes the underlying CloudStack request while the second one hide them and you only manipulate the structs of your interest.
|
||||
|
||||
// Using ListZones request
|
||||
req := &egoscale.ListZones{}
|
||||
resp, err := client.Request(req)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
for _, zone := range resp.(*egoscale.ListZonesResponse) {
|
||||
...
|
||||
}
|
||||
|
||||
// Using client.List
|
||||
zone := &egoscale.Zone{}
|
||||
zones, err := client.List(zone)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
for _, z := range zones {
|
||||
zone := z.(egoscale.Zone)
|
||||
...
|
||||
}
|
||||
|
||||
Elastic IPs
|
||||
|
||||
An Elastic IP is a way to attach an IP address to many Virtual Machines. The API side of the story configures the external environment, like the routing. Some work is required within the machine to properly configure the interfaces.
|
||||
|
||||
See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/networking_and_traffic.html#about-elastic-ips
|
||||
|
||||
*/
|
||||
package egoscale
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue