types

package

v0.2.0 Latest Latest Go to latest Published: Dec 1, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/defenseunicorns/zarf-ui

Links

Open Source Insights

Documentation ¶

Overview ¶

Package types contains all the types used by Zarf.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type APIClusterSummary ¶

type APIClusterSummary struct {
	Reachable   bool              `json:"reachable"`
	HasZarf     bool              `json:"hasZarf"`
	Distro      string            `json:"distro"`
	ZarfState   *zTypes.ZarfState `json:"zarfState"`
	K8sRevision string            `json:"k8sRevision"`
	RawConfig   *api.Config       `json:"rawConfig"`
}

APIClusterSummary contains the summary of a cluster for the API.

type APIConnections ¶

type APIConnections map[string]APIDeployedPackageConnections

APIConnections represents all of the existing connections

type APIDeployedPackageConnection ¶

type APIDeployedPackageConnection struct {
	Name string `json:"name"`
	URL  string `json:"url,omitempty"`
}

APIDeployedPackageConnection represents a single connection from a deployed package

type APIDeployedPackageConnections ¶

type APIDeployedPackageConnections []APIDeployedPackageConnection

APIDeployedPackageConnections represents all of the connections for a deployed package

type APIPackageSBOM ¶

type APIPackageSBOM struct {
	Path  string   `json:"path"`
	SBOMS []string `json:"sboms"`
}

APIPackageSBOM represents the SBOM viewer files for a package

type APIZarfDeployPayload ¶

type APIZarfDeployPayload struct {
	PackageOpts zTypes.ZarfPackageOptions `json:"packageOpts"`
	InitOpts    *zTypes.ZarfInitOptions   `json:"initOpts,omitempty"`
}

APIZarfDeployPayload represents the needed data to deploy a ZarfPackage/ZarfInit

type APIZarfPackage ¶

type APIZarfPackage struct {
	Path        string             `json:"path"`
	Signed      bool               `json:"signed"`
	ZarfPackage zTypes.ZarfPackage `json:"zarfPackage"`
}

APIZarfPackage represents a ZarfPackage and its path for the API.

type RestAPI ¶

type RestAPI struct {
	ZarfPackage                   zTypes.ZarfPackage            `json:"zarfPackage"`
	ZarfState                     zTypes.ZarfState              `json:"zarfState"`
	ZarfCommonOptions             zTypes.ZarfCommonOptions      `json:"zarfCommonOptions"`
	ZarfCreateOptions             zTypes.ZarfCreateOptions      `json:"zarfCreateOptions"`
	ZarfPackageOptions            zTypes.ZarfPackageOptions     `json:"zarfPackageOptions"`
	ZarfInitOptions               zTypes.ZarfInitOptions        `json:"zarfInitOptions"`
	ConnectStrings                zTypes.ConnectStrings         `json:"connectStrings"`
	ClusterSummary                APIClusterSummary             `json:"clusterSummary"`
	DeployedPackage               zTypes.DeployedPackage        `json:"deployedPackage"`
	APIZarfPackage                APIZarfPackage                `json:"apiZarfPackage"`
	APIZarfDeployPayload          APIZarfDeployPayload          `json:"apiZarfDeployPayload"`
	APIZarfPackageConnection      APIDeployedPackageConnection  `json:"apiZarfPackageConnection"`
	APIDeployedPackageConnections APIDeployedPackageConnections `json:"apiZarfPackageConnections"`
	APIConnections                APIConnections                `json:"apiConnections"`
	APIPackageSBOM                APIPackageSBOM                `json:"apiPackageSBOM"`
}

RestAPI is the struct that is used to marshal/unmarshal the top-level API objects.

Source Files ¶

View all Source files

api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL