-
Notifications
You must be signed in to change notification settings - Fork 121
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): restructure into separate files
- Loading branch information
1 parent
6b3ec62
commit ec5ad38
Showing
4 changed files
with
187 additions
and
214 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Development | ||
|
|
||
| 1. Clone the project to your preferred directory, using your preferred method. | ||
| 2. Download the module and accompanying developer tooling. | ||
|
|
||
| ```bash | ||
| $ go mod download | ||
| ``` | ||
|
|
||
| 3. Make changes. | ||
| 4. Verify those changes. | ||
|
|
||
| ```bash | ||
| $ make all | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| # Examples | ||
|
|
||
| Fastly's API is designed to work in the following manner: | ||
|
|
||
| 1. Create (or clone) a new configuration version for the service | ||
| 2. Make any changes to the version | ||
| 3. Validate the version | ||
| 4. Activate the version | ||
|
|
||
| This flow using the Golang client looks like this: | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "github.com/fastly/go-fastly/v8/fastly" | ||
| ) | ||
|
|
||
| func main() { | ||
| // Create a client object. The client has no state, so it can be persisted | ||
| // and re-used. It is also safe to use concurrently due to its lack of state. | ||
| // There is also a DefaultClient() method that reads an environment variable. | ||
| // Please see the documentation for more information and details. | ||
| client, err := fastly.NewClient(os.Getenv("FASTLY_API_KEY")) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| // You can find the service ID in the Fastly web console. | ||
| var serviceID = "SERVICE_ID" | ||
|
|
||
| // We'll get the latest 'active' version by inspecting the service metadata and | ||
| // then finding which available version is the 'active' version. | ||
| service, err := client.GetService(&fastly.GetServiceInput{ | ||
| ID: serviceID, | ||
| }) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| // Let's acquire a service version to clone from. We'll start by searching for | ||
| // the latest 'active' version available, and if there are no active versions, | ||
| // then we'll clone from whatever is the latest version. | ||
| latest := service.Versions[len(service.Versions)-1] | ||
| for _, version := range service.Versions { | ||
| if version.Active { | ||
| latest = version | ||
| break | ||
| } | ||
| } | ||
|
|
||
| // Clone the latest version so we can make changes without affecting the | ||
| // active configuration. | ||
| version, err := client.CloneVersion(&fastly.CloneVersionInput{ | ||
| ServiceID: serviceID, | ||
| ServiceVersion: latest.Number, | ||
| }) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| // Now you can make any changes to the new version. In this example, we will add | ||
| // a new domain. | ||
| domain, err := client.CreateDomain(&fastly.CreateDomainInput{ | ||
| ServiceID: serviceID, | ||
| ServiceVersion: version.Number, | ||
| Name: String("example.com"), | ||
| }) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| // Output: "example.com" | ||
| fmt.Println("domain.Name:", domain.Name) | ||
|
|
||
| // And we will also add a new backend. | ||
| backend, err := client.CreateBackend(&fastly.CreateBackendInput{ | ||
| ServiceID: serviceID, | ||
| ServiceVersion: version.Number, | ||
| Name: String("example-backend"), | ||
| Address: String("127.0.0.1"), | ||
| Port: Int(80), | ||
| }) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| // Output: "example-backend" | ||
| fmt.Println("backend.Name:", backend.Name) | ||
|
|
||
| // Now we can validate that our version is valid. | ||
| valid, _, err := client.ValidateVersion(&fastly.ValidateVersionInput{ | ||
| ServiceID: serviceID, | ||
| ServiceVersion: version.Number, | ||
| }) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if !valid { | ||
| log.Fatal("not valid version") | ||
| } | ||
|
|
||
| // Finally, activate this new version. | ||
| activeVersion, err := client.ActivateVersion(&fastly.ActivateVersionInput{ | ||
| ServiceID: serviceID, | ||
| ServiceVersion: version.Number, | ||
| }) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| // Output: true | ||
| fmt.Println("activeVersion.Locked:", activeVersion.Locked) | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.