StateDoc.Comments[encoder.LineComment]="State describe the entire state to describe a Constellation cluster."
StateDoc.Description="State describe the entire state to describe a Constellation cluster."
StateDoc.Fields=make([]encoder.Doc,3)
StateDoc.Fields[0].Name="version"
StateDoc.Fields[0].Type="string"
StateDoc.Fields[0].Note=""
StateDoc.Fields[0].Description="Schema version of this state file."
StateDoc.Fields[0].Comments[encoder.LineComment]="Schema version of this state file."
StateDoc.Fields[1].Name="infrastructure"
StateDoc.Fields[1].Type="Infrastructure"
StateDoc.Fields[1].Note=""
StateDoc.Fields[1].Description="State of the cluster's cloud resources. These values are retrieved during\ncluster creation. In the case of self-managed infrastructure, the marked\nfields in this struct should be filled by the user as per\nhttps://docs.edgeless.systems/constellation/workflows/create."
StateDoc.Fields[1].Comments[encoder.LineComment]="State of the cluster's cloud resources. These values are retrieved during"
StateDoc.Fields[2].Name="clusterValues"
StateDoc.Fields[2].Type="ClusterValues"
StateDoc.Fields[2].Note=""
StateDoc.Fields[2].Description="DO NOT EDIT. State of the Constellation Kubernetes cluster.\nThese values are set during cluster initialization and should not be changed."
StateDoc.Fields[2].Comments[encoder.LineComment]="DO NOT EDIT. State of the Constellation Kubernetes cluster."
ClusterValuesDoc.Type="ClusterValues"
ClusterValuesDoc.Comments[encoder.LineComment]="ClusterValues describe the (Kubernetes) cluster state, set during initialization of the cluster."
ClusterValuesDoc.Description="ClusterValues describe the (Kubernetes) cluster state, set during initialization of the cluster."
ClusterValuesDoc.AppearsIn=[]encoder.Appearance{
{
TypeName:"State",
FieldName:"clusterValues",
},
}
ClusterValuesDoc.Fields=make([]encoder.Doc,3)
ClusterValuesDoc.Fields[0].Name="clusterID"
ClusterValuesDoc.Fields[0].Type="string"
ClusterValuesDoc.Fields[0].Note=""
ClusterValuesDoc.Fields[0].Description="Unique identifier of the cluster."
ClusterValuesDoc.Fields[0].Comments[encoder.LineComment]="Unique identifier of the cluster."
ClusterValuesDoc.Fields[1].Name="ownerID"
ClusterValuesDoc.Fields[1].Type="string"
ClusterValuesDoc.Fields[1].Note=""
ClusterValuesDoc.Fields[1].Description="Unique identifier of the owner of the cluster."
ClusterValuesDoc.Fields[1].Comments[encoder.LineComment]="Unique identifier of the owner of the cluster."
InfrastructureDoc.Fields[1].Description="Endpoint the cluster can be reached at. This is the endpoint that is being used by the CLI."
InfrastructureDoc.Fields[1].Comments[encoder.LineComment]="Endpoint the cluster can be reached at. This is the endpoint that is being used by the CLI."
InfrastructureDoc.Fields[2].Description="The Cluster uses to reach itself. This might differ from the ClusterEndpoint in case e.g.,\nan internal load balancer is used."
InfrastructureDoc.Fields[2].Comments[encoder.LineComment]="The Cluster uses to reach itself. This might differ from the ClusterEndpoint in case e.g.,"
InfrastructureDoc.Fields[4].Description="List of Subject Alternative Names (SANs) to add to the Kubernetes API server certificate.\nIf no SANs should be added, this field can be left empty."
InfrastructureDoc.Fields[4].Comments[encoder.LineComment]="List of Subject Alternative Names (SANs) to add to the Kubernetes API server certificate."
AzureDoc.Fields[2].Description="Security group name of the cluster's resource group."
AzureDoc.Fields[2].Comments[encoder.LineComment]="Security group name of the cluster's resource group."
AzureDoc.Fields[3].Name="loadBalancerName"
AzureDoc.Fields[3].Type="string"
AzureDoc.Fields[3].Note=""
AzureDoc.Fields[3].Description="Name of the cluster's load balancer."
AzureDoc.Fields[3].Comments[encoder.LineComment]="Name of the cluster's load balancer."
AzureDoc.Fields[4].Name="userAssignedIdentity"
AzureDoc.Fields[4].Type="string"
AzureDoc.Fields[4].Note=""
AzureDoc.Fields[4].Description="ID of the UAMI the cluster's nodes are running with."
AzureDoc.Fields[4].Comments[encoder.LineComment]="ID of the UAMI the cluster's nodes are running with."
AzureDoc.Fields[5].Name="attestationURL"
AzureDoc.Fields[5].Type="string"
AzureDoc.Fields[5].Note=""
AzureDoc.Fields[5].Description="MAA endpoint that can be used as a fallback for veryifying the ID key digests\nin the cluster's attestation report if the enforcement policy is set accordingly.\nCan be left empty otherwise."
AzureDoc.Fields[5].Comments[encoder.LineComment]="MAA endpoint that can be used as a fallback for veryifying the ID key digests"
}
func(_State)Doc()*encoder.Doc{
return&StateDoc
}
func(_ClusterValues)Doc()*encoder.Doc{
return&ClusterValuesDoc
}
func(_Infrastructure)Doc()*encoder.Doc{
return&InfrastructureDoc
}
func(_GCP)Doc()*encoder.Doc{
return&GCPDoc
}
func(_Azure)Doc()*encoder.Doc{
return&AzureDoc
}
// GetConfigurationDoc returns documentation for the file ./state_doc.go.
funcGetConfigurationDoc()*encoder.FileDoc{
return&encoder.FileDoc{
Name:"Configuration",
Description:"package state defines the structure of the Constellation state file.\n",
