Documentation
¶
Overview ¶
Package packages provides api functions for managing Zarf packages.
Package packages provides api functions for managing Zarf packages.
Package packages provides api functions for managing Zarf packages.
Package packages provides api functions for managing Zarf packages.
Package packages provides api functions for managing Zarf packages.
Package packages provides api functions for managing Zarf packages.
Package packages provides api functions for managing Zarf packages.
Index ¶
- func ConnectTunnel(w http.ResponseWriter, r *http.Request)
- func DeleteSBOM(w http.ResponseWriter, _ *http.Request)
- func DeployPackage(w http.ResponseWriter, r *http.Request)
- func DisconnectTunnel(w http.ResponseWriter, r *http.Request)
- func ExtractSBOM(w http.ResponseWriter, r *http.Request)
- func FindInHomeStream(w http.ResponseWriter, r *http.Request)
- func FindInitStream(w http.ResponseWriter, _ *http.Request)
- func FindPackageStream(w http.ResponseWriter, _ *http.Request)
- func ListConnections(w http.ResponseWriter, _ *http.Request)
- func ListDeployedPackages(w http.ResponseWriter, _ *http.Request)
- func ListPackageConnections(w http.ResponseWriter, r *http.Request)
- func Read(w http.ResponseWriter, r *http.Request)
- func ReadPackage(path string) (pkg types.APIZarfPackage, err error)
- func RemovePackage(w http.ResponseWriter, r *http.Request)
- func StreamDeployPackage(w http.ResponseWriter, r *http.Request)
- type PackageTunnel
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConnectTunnel ¶ added in v0.26.3
func ConnectTunnel(w http.ResponseWriter, r *http.Request)
ConnectTunnel establishes a tunnel for the requested resource
func DeleteSBOM ¶ added in v0.27.0
func DeleteSBOM(w http.ResponseWriter, _ *http.Request)
DeleteSBOM removes the SBOM directory
func DeployPackage ¶
func DeployPackage(w http.ResponseWriter, r *http.Request)
DeployPackage deploys a package to the Zarf cluster.
func DisconnectTunnel ¶ added in v0.26.3
func DisconnectTunnel(w http.ResponseWriter, r *http.Request)
DisconnectTunnel closes the tunnel for the requested resource
func ExtractSBOM ¶ added in v0.27.0
func ExtractSBOM(w http.ResponseWriter, r *http.Request)
ExtractSBOM Extracts the SBOM from the package and returns the path to the SBOM
func FindInHomeStream ¶ added in v0.28.0
func FindInHomeStream(w http.ResponseWriter, r *http.Request)
FindInHomeStream returns all packages in the user's home directory. If the init query parameter is true, only init packages will be returned.
func FindInitStream ¶ added in v0.28.0
func FindInitStream(w http.ResponseWriter, _ *http.Request)
FindInitStream finds and streams all init packages in the current working directory, the cache directory, and execution directory
func FindPackageStream ¶ added in v0.28.0
func FindPackageStream(w http.ResponseWriter, _ *http.Request)
FindPackageStream finds and streams all packages in the current working directory
func ListConnections ¶ added in v0.26.3
func ListConnections(w http.ResponseWriter, _ *http.Request)
ListConnections returns a map of pkgName to a list of connections
func ListDeployedPackages ¶
func ListDeployedPackages(w http.ResponseWriter, _ *http.Request)
ListDeployedPackages writes a list of packages that have been deployed to the connected cluster.
func ListPackageConnections ¶ added in v0.26.3
func ListPackageConnections(w http.ResponseWriter, r *http.Request)
ListPackageConnections lists all tunnel names
func Read ¶
func Read(w http.ResponseWriter, r *http.Request)
Read reads a package from the local filesystem and writes the Zarf.yaml json to the response.
func ReadPackage ¶ added in v0.28.0
func ReadPackage(path string) (pkg types.APIZarfPackage, err error)
ReadPackage reads a packages yaml from the local filesystem and returns an APIZarfPackage.
func RemovePackage ¶
func RemovePackage(w http.ResponseWriter, r *http.Request)
RemovePackage removes a package that has been deployed to the cluster.
func StreamDeployPackage ¶ added in v0.26.0
func StreamDeployPackage(w http.ResponseWriter, r *http.Request)
StreamDeployPackage Establishes a stream that redirects pterm output to the stream Resets the output to std.err after the stream connection is closed
Types ¶
type PackageTunnel ¶ added in v0.26.3
type PackageTunnel struct {
Connection types.APIDeployedPackageConnection `json:"connection,omitempty"`
// contains filtered or unexported fields
}
PackageTunnel is a struct for storing a tunnel and its connection details
Source Files