Documentation
¶
Index ¶
- func WithAcceptedAlgorithms(acceptedAlgorithms []string) func(*Client)
- func WithArtifactInspectors(inspectors []inspector.ArtifactInspector) func(client *Client)
- func WithBackoffStrategy(b backoff.Strategy) func(*Client)
- func WithContext(ctx context.Context) func(*Client)
- func WithCredential(registry string, credential auth.Credential) func(*Client)
- func WithDockerConfigPath(dockerConfigPath string) func(*Client)
- func WithInsecureAllowHTTP(insecureAllowHTTP bool) func(*Client)
- func WithInternalDirectory(internalDirectory string) func(*Client)
- func WithKeepOldDir(keepOldDir bool) func(*Client)
- func WithManifestValidators(validators []validator.ManifestValidator) func(client *Client)
- func WithOutputDirPermissions(outputDirPermissions os.FileMode) func(*Client)
- func WithOutputDirectory(outputDirectory string) func(*Client)
- func WithRemoteURL(remoteURL string) func(*Client)
- type Client
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithAcceptedAlgorithms ¶
WithAcceptedAlgorithms allows to restrict the set of accepted algorithms which are used to build a delta.
func WithArtifactInspectors ¶ added in v0.18.0
func WithArtifactInspectors(inspectors []inspector.ArtifactInspector) func(client *Client)
WithArtifactInspectors configures a Client with a list of ArtifactInspector instances to be used for artifact inspection.
func WithBackoffStrategy ¶ added in v0.10.0
WithBackoffStrategy adds ...
func WithContext ¶ added in v0.10.0
WithContext adds a ctx to the client (e.g. for cancellation).
func WithCredential ¶ added in v0.11.0
func WithCredential(registry string, credential auth.Credential) func(*Client)
WithCredential adds registry scoped credentials to the client.
func WithDockerConfigPath ¶
WithDockerConfigPath adds a path to a docker config file to the client configuration. The file is used to load locally stored registry credentials.
func WithInsecureAllowHTTP ¶ added in v0.13.0
WithInsecureAllowHTTP configures the clients to allow HTTP requests.
func WithInternalDirectory ¶
WithInternalDirectory sets the client configurations local working directory. It stores things such as the updater's internal state.
func WithKeepOldDir ¶ added in v0.15.1
WithKeepOldDir if set to true directories are not replaced, this is less robust.
func WithManifestValidators ¶ added in v0.18.0
func WithManifestValidators(validators []validator.ManifestValidator) func(client *Client)
WithManifestValidators adds a collection of validators to the client which inspect the manifest before fetching the artifact.
func WithOutputDirPermissions ¶ added in v0.19.1
WithOutputDirPermissions allows users to control the permissions of the output directory.
func WithOutputDirectory ¶
WithOutputDirectory adds a directory to which output files are written.
func WithRemoteURL ¶
WithRemoteURL adds the URL of a Doras server to the client configuration.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is used to run delta updates in Doras.