Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-04-21 15:56:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

generate

Browse Source
This commit is contained in:
miampf 2024-04-18 15:59:04 +02:00
parent ba6b80cdf5
commit 46b2cfff22
No known key found for this signature in database
GPG Key ID: EF039364B5B6886C
2 changed files with 43 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/docs/reference/cli.md
View File

@ -81,6 +81,7 @@ constellation config generate {aws|azure|gcp|openstack|qemu|stackit} [flags]
-a, --attestation string attestation variant to use {aws-sev-snp|aws-nitro-tpm|azure-sev-snp|azure-tdx|azure-trustedlaunch|gcp-sev-es|gcp-sev-snp|qemu-vtpm}. If not specified, the default for the cloud provider is used
-h, --help help for generate
-k, --kubernetes string Kubernetes version to use in format MAJOR.MINOR (default "v1.28")
-t, --tags string Additional tags for created resources.
```
### Options inherited from parent commands

79
internal/config/config_doc.go
View File

@ -37,7 +37,7 @@ func init() {
ConfigDoc.Type = "Config"
ConfigDoc.Comments[encoder.LineComment] = "Config defines configuration used by CLI."
ConfigDoc.Description = "Config defines configuration used by CLI."
ConfigDoc.Fields = make([]encoder.Doc, 12)
ConfigDoc.Fields = make([]encoder.Doc, 13)
ConfigDoc.Fields[0].Name = "version"
ConfigDoc.Fields[0].Type = "string"
ConfigDoc.Fields[0].Note = ""
@ -53,51 +53,56 @@ func init() {
ConfigDoc.Fields[2].Note = ""
ConfigDoc.Fields[2].Description = "Name of the cluster."
ConfigDoc.Fields[2].Comments[encoder.LineComment] = "Name of the cluster."
ConfigDoc.Fields[3].Name = "kubernetesVersion"
ConfigDoc.Fields[3].Type = "ValidK8sVersion"
ConfigDoc.Fields[3].Name = "tags"
ConfigDoc.Fields[3].Type = "Tags"
ConfigDoc.Fields[3].Note = ""
ConfigDoc.Fields[3].Description = "Kubernetes version to be installed into the cluster."
ConfigDoc.Fields[3].Comments[encoder.LineComment] = "Kubernetes version to be installed into the cluster."
ConfigDoc.Fields[4].Name = "microserviceVersion"
ConfigDoc.Fields[4].Type = "Semver"
ConfigDoc.Fields[3].Description = "description : |\n Custom tags to be applied to created cloud resources.\n"
ConfigDoc.Fields[3].Comments[encoder.LineComment] = "description : |"
ConfigDoc.Fields[4].Name = "kubernetesVersion"
ConfigDoc.Fields[4].Type = "ValidK8sVersion"
ConfigDoc.Fields[4].Note = ""
ConfigDoc.Fields[4].Description = "Microservice version to be installed into the cluster. Defaults to the version of the CLI."
ConfigDoc.Fields[4].Comments[encoder.LineComment] = "Microservice version to be installed into the cluster. Defaults to the version of the CLI."
ConfigDoc.Fields[5].Name = "debugCluster"
ConfigDoc.Fields[5].Type = "bool"
ConfigDoc.Fields[4].Description = "Kubernetes version to be installed into the cluster."
ConfigDoc.Fields[4].Comments[encoder.LineComment] = "Kubernetes version to be installed into the cluster."
ConfigDoc.Fields[5].Name = "microserviceVersion"
ConfigDoc.Fields[5].Type = "Semver"
ConfigDoc.Fields[5].Note = ""
ConfigDoc.Fields[5].Description = "DON'T USE IN PRODUCTION: enable debug mode and use debug images."
ConfigDoc.Fields[5].Comments[encoder.LineComment] = "DON'T USE IN PRODUCTION: enable debug mode and use debug images."
ConfigDoc.Fields[6].Name = "customEndpoint"
ConfigDoc.Fields[6].Type = "string"
ConfigDoc.Fields[5].Description = "Microservice version to be installed into the cluster. Defaults to the version of the CLI."
ConfigDoc.Fields[5].Comments[encoder.LineComment] = "Microservice version to be installed into the cluster. Defaults to the version of the CLI."
ConfigDoc.Fields[6].Name = "debugCluster"
ConfigDoc.Fields[6].Type = "bool"
ConfigDoc.Fields[6].Note = ""
ConfigDoc.Fields[6].Description = "Optional custom endpoint (DNS name) for the Constellation API server.\nThis can be used to point a custom dns name at the Constellation API server\nand is added to the Subject Alternative Name (SAN) field of the TLS certificate used by the API server.\nA fallback to DNS name is always available."
ConfigDoc.Fields[6].Comments[encoder.LineComment] = "Optional custom endpoint (DNS name) for the Constellation API server."
ConfigDoc.Fields[7].Name = "internalLoadBalancer"
ConfigDoc.Fields[7].Type = "bool"
ConfigDoc.Fields[6].Description = "DON'T USE IN PRODUCTION: enable debug mode and use debug images."
ConfigDoc.Fields[6].Comments[encoder.LineComment] = "DON'T USE IN PRODUCTION: enable debug mode and use debug images."
ConfigDoc.Fields[7].Name = "customEndpoint"
ConfigDoc.Fields[7].Type = "string"
ConfigDoc.Fields[7].Note = ""
ConfigDoc.Fields[7].Description = "Flag to enable/disable the internal load balancer. If enabled, the Constellation is only accessible from within the VPC."
ConfigDoc.Fields[7].Comments[encoder.LineComment] = "Flag to enable/disable the internal load balancer. If enabled, the Constellation is only accessible from within the VPC."
ConfigDoc.Fields[8].Name = "serviceCIDR"
ConfigDoc.Fields[8].Type = "string"
ConfigDoc.Fields[7].Description = "Optional custom endpoint (DNS name) for the Constellation API server.\nThis can be used to point a custom dns name at the Constellation API server\nand is added to the Subject Alternative Name (SAN) field of the TLS certificate used by the API server.\nA fallback to DNS name is always available."
ConfigDoc.Fields[7].Comments[encoder.LineComment] = "Optional custom endpoint (DNS name) for the Constellation API server."
ConfigDoc.Fields[8].Name = "internalLoadBalancer"
ConfigDoc.Fields[8].Type = "bool"
ConfigDoc.Fields[8].Note = ""
ConfigDoc.Fields[8].Description = "The Kubernetes Service CIDR to be used for the cluster. This value will only be used during the first initialization of the Constellation."
ConfigDoc.Fields[8].Comments[encoder.LineComment] = "The Kubernetes Service CIDR to be used for the cluster. This value will only be used during the first initialization of the Constellation."
ConfigDoc.Fields[9].Name = "provider"
ConfigDoc.Fields[9].Type = "ProviderConfig"
ConfigDoc.Fields[8].Description = "Flag to enable/disable the internal load balancer. If enabled, the Constellation is only accessible from within the VPC."
ConfigDoc.Fields[8].Comments[encoder.LineComment] = "Flag to enable/disable the internal load balancer. If enabled, the Constellation is only accessible from within the VPC."
ConfigDoc.Fields[9].Name = "serviceCIDR"
ConfigDoc.Fields[9].Type = "string"
ConfigDoc.Fields[9].Note = ""
ConfigDoc.Fields[9].Description = "Supported cloud providers and their specific configurations."
ConfigDoc.Fields[9].Comments[encoder.LineComment] = "Supported cloud providers and their specific configurations."
ConfigDoc.Fields[10].Name = "nodeGroups"
ConfigDoc.Fields[10].Type = "map[string]NodeGroup"
ConfigDoc.Fields[9].Description = "The Kubernetes Service CIDR to be used for the cluster. This value will only be used during the first initialization of the Constellation."
ConfigDoc.Fields[9].Comments[encoder.LineComment] = "The Kubernetes Service CIDR to be used for the cluster. This value will only be used during the first initialization of the Constellation."
ConfigDoc.Fields[10].Name = "provider"
ConfigDoc.Fields[10].Type = "ProviderConfig"
ConfigDoc.Fields[10].Note = ""
ConfigDoc.Fields[10].Description = "Node groups to be created in the cluster."
ConfigDoc.Fields[10].Comments[encoder.LineComment] = "Node groups to be created in the cluster."
ConfigDoc.Fields[11].Name = "attestation"
ConfigDoc.Fields[11].Type = "AttestationConfig"
ConfigDoc.Fields[10].Description = "Supported cloud providers and their specific configurations."
ConfigDoc.Fields[10].Comments[encoder.LineComment] = "Supported cloud providers and their specific configurations."
ConfigDoc.Fields[11].Name = "nodeGroups"
ConfigDoc.Fields[11].Type = "map[string]NodeGroup"
ConfigDoc.Fields[11].Note = ""
ConfigDoc.Fields[11].Description = "Configuration for attestation validation. This configuration provides sensible defaults for the Constellation version it was created for.\nSee the docs for an overview on attestation: https://docs.edgeless.systems/constellation/architecture/attestation"
ConfigDoc.Fields[11].Comments[encoder.LineComment] = "Configuration for attestation validation. This configuration provides sensible defaults for the Constellation version it was created for.\nSee the docs for an overview on attestation: https://docs.edgeless.systems/constellation/architecture/attestation"
ConfigDoc.Fields[11].Description = "Node groups to be created in the cluster."
ConfigDoc.Fields[11].Comments[encoder.LineComment] = "Node groups to be created in the cluster."
ConfigDoc.Fields[12].Name = "attestation"
ConfigDoc.Fields[12].Type = "AttestationConfig"
ConfigDoc.Fields[12].Note = ""
ConfigDoc.Fields[12].Description = "Configuration for attestation validation. This configuration provides sensible defaults for the Constellation version it was created for.\nSee the docs for an overview on attestation: https://docs.edgeless.systems/constellation/architecture/attestation"
ConfigDoc.Fields[12].Comments[encoder.LineComment] = "Configuration for attestation validation. This configuration provides sensible defaults for the Constellation version it was created for.\nSee the docs for an overview on attestation: https://docs.edgeless.systems/constellation/architecture/attestation"
ProviderConfigDoc.Type = "ProviderConfig"
ProviderConfigDoc.Comments[encoder.LineComment] = "ProviderConfig are cloud-provider specific configuration values used by the CLI."