package
0.0.0-20230628214157-3bfe64699e82
Repository: https://github.com/gravitational/gravity.git
Documentation: pkg.go.dev
# README
Application Format
Gravity application is a tarball, i.e. any .tar.gz
file. The file has the following structure:
app.tar.gz
├── registry
│ └── docker
│ └── registry
│ └── v2 ...
│ ...
└── resources
├── app.yaml
└── skydns.yaml
Only the registry
and resources
directories are mandatory, the rest is application-specific.
In this example:
registry
stores docker image layers in theregistry v2
format. See assets/dns-app/Makefile to get an understanding about how it is produced.resources
contains the application manifest.
The rest is application-specific.
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
+groupName=gravitational.io.
Copyright 2021 Gravitational, Inc.
package suite contains a backend-independent application service acceptance test suite.
# Functions
ApplicationsWithACL returns an instance of the Applications interface with the specified security context.
AppsToExclude returns a list of apps that should be excluded.
CheckHasAppHook checks if the app has specified hook.
DeleteAppHookJob deletes app hook job.
GetDependencies transitively collects dependencies for the specified application package.
GetDirectDeps returns the direct application dependencies, without base app resolution.
GetUpdatedDependencies compares dependencies of the "installed" and "update" apps and returns locators of updated (or new) dependencies.
RunAppHook launches the specified hook, waits for its completion and returns its output and job reference.
StreamAppHook launches the specified hook and starts streaming its output into the provided writer until the job completes.
StreamAppHookLogs streams app hook logs to output writer, this is a blocking call.
Unwrap unwraps []Locator from []Dependency.
VerifyDependencies verifies that the specified application app has all the dependent packages available in the provided package service.
WaitAppHook waits for app hook to complete or fail.
Wrap wraps a []Locator into []Dependency.
# Constants
AppOperationImport defines an application import operation type.
DefaultNamespace is the name of the default application namespace.
ImportStateCreatingPackage defines the state of creating an application package.
ImportStatePullingImages defines the state of pulling docker images.
ImportStateStoringRegistry defines the state of storing image layers into temporary registry.
LabelName defines the name label every application resource is annotated with.
LabelVersion defines the version label every application resource is annotated with.
ProgressStateCompleted defines a successful operation.
ProgressStateInProgress defines an operation in progress.
# Variables
OptionalDependencies specifies what dependencies can be disabled.
Phony describes a broken application reference.
ProgressStateFailed is a final progress state that signifies a failed operation.
# Structs
Application defines a Gravity application.
ApplicationsACL defines a security aware wrapper around Applications.
DeleteAppHookJobRequest is a request to delete a hook job.
DeleteRequest describes a request to delete an application.
Dependencies defines a set of package and application dependencies for an application.
ExportAppRequest defines a set of parameters for exporting an application to a docker registry.
HookRef is a reference to a hook running as a kubernetes job.
HookRunRequest defines a request to run a specific application hook.
ImportRequest is a request to import an application.
InstallAppRequest defines a request to install an application.
InstallerRequest defines a request to create an installer tarball.
InstallerRequestRaw is the same as InstallerRequest but can be marshaled and unmarshaled when passed in API call.
ListAppsRequest is a request to show applications in a repository.
No description provided by the author
UpdateAppRequest defines a request to update an application.
# Interfaces
Applications manages a collection of applications.
Logger defines an interface to log messages.
Operations defines a set of operations on applications.
# Type aliases
ImportState defines a set of application import states.
ProgressEntry defines a single progress step in a complex operation (i.e.
ProgressFailure defines a set of failed states.
ProgressSuccess defines a set of success states.