Categorygithub.com/superfly/fly-go
modulepackage
0.1.28
Repository: https://github.com/superfly/fly-go.git
Documentation: pkg.go.dev

# README

fly-go

Go client for the Fly.io API. This library is primarily used by flyctl but it can be used by any project that wants to automate its Fly.io deployment.

Development

If you are making changes in another project and need to test fly-go changes locally, you can enable a Go workspace. For example, if you have a directory structure like this:

superfly/
├── fly-go
└── flyctl

Then you can initialize a Go workspace in the superfly parent directory and add your project directories so that flyctl can use your local fly-go:

go work init
go work use ./flyctl
go work use ./fly-go

Cutting a Release

If you have write access to this repo, you can ship a release with:

scripts/bump_version.sh

Or a prerelease with:

scripts/bump_version.sh prerel

The release and notes will be created automatically via Github Actions. Follow along in: https://github.com/superfly/fly-go/actions/workflows/release.yml

# Packages

No description provided by the author
No description provided by the author

# Functions

No description provided by the author
BoolPointer - Returns a pointer to a bool.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetAccessToken - uses email, password and possible otp to get token.
GetAccessTokenForCLISession Obtains the access token for the session.
No description provided by the author
IntPointer - Returns a pointer to an int.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MergeFiles merges the files parsed from the command line or fly.toml into the machine configuration.
MustParseDuration is like ParseDuration but panics if the expression cannot be parsed.
NewClient - creates a new Client, takes an access token.
No description provided by the author
No description provided by the author
No description provided by the author
Compile parses a duration and returns, if successful, a Duration object.
Pointer - Returns a pointer to a any type.
SetBaseURL - Sets the base URL for the API.
SetErrorLog - Sets whether errors should be loddes.
No description provided by the author
No description provided by the author
StartCLISession starts a session with the platform via web.
StartCLISessionWebAuth starts a session with the platform via web auth.
StringPointer - Returns a pointer to a string.
No description provided by the author
WithAuthorizationHeader returns a context that instructs the client to use the specified Authorization header value.

# Constants

Secret types.
The query or mutation executed by CreateBuild.
The query or mutation executed by CreateRelease.
No description provided by the author
No description provided by the author
No description provided by the author
Launch all new instances before shutting down previous instances.
Ensure new instances are healthy before continuing with a rolling deployment.
Deploy new instances all at once.
Incrementally replace old instances with new ones.
Incrementally replace old instances with new ones, 1 by 1.
Deploy new instances all at once.
The query or mutation executed by EnsureDepotRemoteBuilder.
The query or mutation executed by FinishBuild.
The query or mutation executed by LatestImage.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The query or mutation executed by UpdateRelease.
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
ErrNotFound - Error to return when something is not found.
ErrUnknown - Error to return when an unknown server error occurs.
No description provided by the author
No description provided by the author
No description provided by the author
Informational check.
Readiness check.
TODO - Determine if we want allocate max memory allocation, or minimum per # cpus.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Client - API client encapsulating the http and GraphQL clients.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreateBuildCreateBuildCreateBuildPayload includes the requested fields of the GraphQL type CreateBuildPayload.
Autogenerated input type of CreateBuild.
CreateBuildResponse is returned by CreateBuild on success.
No description provided by the author
No description provided by the author
No description provided by the author
CreateReleaseCreateReleaseCreateReleasePayload includes the requested fields of the GraphQL type CreateReleasePayload.
CreateReleaseCreateReleaseCreateReleasePayloadRelease includes the requested fields of the GraphQL type Release.
Autogenerated input type of CreateRelease.
CreateReleaseResponse is returned by CreateRelease on success.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EnsureDepotRemoteBuilderEnsureDepotRemoteBuilderEnsureDepotRemoteBuilderPayload includes the requested fields of the GraphQL type EnsureDepotRemoteBuilderPayload.
Autogenerated input type of EnsureDepotRemoteBuilder.
EnsureDepotRemoteBuilderResponse is returned by EnsureDepotRemoteBuilder on success.
No description provided by the author
@description EnvVar defines an environment variable to be populated from a machine field, env_var and field_ref are required.
No description provided by the author
No description provided by the author
@description A file that will be written to the Machine.
FinishBuildFinishBuildFinishBuildPayload includes the requested fields of the GraphQL type FinishBuildPayload.
Autogenerated input type of FinishBuild.
FinishBuildResponse is returned by FinishBuild on success.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LatestImageApp includes the requested fields of the GraphQL type App.
LatestImageAppCurrentReleaseUnprocessed includes the requested fields of the GraphQL type ReleaseUnprocessed.
LatestImageResponse is returned by LatestImage on success.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
@description An optional object that defines one or more named checks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
@description For http checks, an array of objects with string field Name and array of strings field Values.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
@description The Machine restart policy defines whether and how flyd restarts a Machine after its main process exits.
@description A Secret needing to be set in the environment of the Machine.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Query - Master query which encapsulates all possible returned structures.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Autogenerated input type of UpdateRelease.
UpdateReleaseResponse is returned by UpdateRelease on success.
UpdateReleaseUpdateReleaseUpdateReleasePayload includes the requested fields of the GraphQL type UpdateReleasePayload.
UpdateReleaseUpdateReleaseUpdateReleasePayloadRelease includes the requested fields of the GraphQL type Release.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author