mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-01-23 05:41:19 -05:00
Update references to docs (#36)
This commit is contained in:
Moritz Eckert
GitHub
parent
276165064e
commit
db942ee4b5
4
.github/workflows/update-cli-reference.yml
vendored
4
.github/workflows/update-cli-reference.yml
vendored
@ -52,7 +52,7 @@ jobs:
|
||||
source_file: 'cli.md'
|
||||
destination_repo: 'edgelesssys/constellation-docs'
|
||||
destination_branch_create: 'action/constellation/update-cli-reference'
|
||||
destination_folder: 'constellation/1.4/reference'
|
||||
destination_folder: 'docs/reference'
|
||||
user_name: '${{ github.actor }}'
|
||||
user_email: '${{ github.actor }}@users.noreply.github.com'
|
||||
commit_message: 'CLI reference was updated by edgelesssys/constellation@${{ env.COMMIT_END}}'
|
||||
@ -66,7 +66,7 @@ jobs:
|
||||
source_file: 'cli.md'
|
||||
destination_repo: 'edgelesssys/constellation-docs'
|
||||
destination_branch: 'action/constellation/update-cli-reference'
|
||||
destination_folder: 'constellation/1.4/reference'
|
||||
destination_folder: 'docs/reference'
|
||||
user_name: '${{ github.actor }}'
|
||||
user_email: '${{ github.actor }}@users.noreply.github.com'
|
||||
commit_message: 'CLI reference was updated by edgelesssys/constellation@${{ env.COMMIT_END}}'
|
||||
|
||||
@ -131,10 +131,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
### Added
|
||||
|
||||
- Early boot logging for GCP and Azure. [[Docs]](https://docs.edgeless.systems/constellation/latest/#/workflows/troubleshooting?id=cloud-logging)
|
||||
- `constellation-access-manager` allows users to manage SSH users over a ConfigMap. Enables persistent and dynamic management of SSH users on multiple nodes, even after a reboot. [[Docs]](https://docs.edgeless.systems/constellation/latest/#/workflows/ssh)
|
||||
- GCP-native Kubernetes load balancing. [[Docs]](https://docs.edgeless.systems/constellation/latest/#/architecture/networking)
|
||||
- `constellation version` prints more information to aid in troubleshooting. [[Docs]](https://docs.edgeless.systems/constellation/latest/#/reference/cli?id=constellation-version)
|
||||
- Early boot logging for GCP and Azure. [[Docs]](https://docs.edgeless.systems/constellation/workflows/troubleshooting#cloud-logging)
|
||||
- `constellation-access-manager` allows users to manage SSH users over a ConfigMap. Enables persistent and dynamic management of SSH users on multiple nodes, even after a reboot. [[Docs]](https://docs.edgeless.systems/constellation/workflows/ssh)
|
||||
- GCP-native Kubernetes load balancing. [[Docs]](https://docs.edgeless.systems/constellation/architecture/networking)
|
||||
- `constellation version` prints more information to aid in troubleshooting. [[Docs]](https://docs.edgeless.systems/constellation/reference/cli#constellation-version)
|
||||
- Standard logging for all services and CLI, allows users to control output in a consistent manner.
|
||||
- `constellation-id.json` in Constellation workspace now holds cluster IDs, to reduce required arguments in Constellation commands, e.g., `constellation verify`.
|
||||
|
||||
|
||||
@ -124,7 +124,7 @@ To enable the upload, an additional **unsecured** port (4000) is opened which ac
|
||||
|
||||
## Cloud credentials
|
||||
|
||||
Using the CLI requires the user to make authorized API calls to the CSP API. See the [docs](https://docs.edgeless.systems/constellation/latest/#/getting-started/install?id=cloud-credentials) for configuration.
|
||||
Using the CLI requires the user to make authorized API calls to the CSP API. See the [docs](https://docs.edgeless.systems/constellation/getting-started/install#set-up-cloud-credentials) for configuration.
|
||||
|
||||
## Deploying a locally compiled bootstrapper binary
|
||||
|
||||
|
||||
36
README.md
36
README.md
@ -132,42 +132,42 @@ If you require a cluster with more than 8 vCPUs or need other services such as e
|
||||
TODO
|
||||
|
||||
<!-- refs -->
|
||||
[architecture]: https://docs.edgeless.systems/constellation/latest/#/architecture/overview
|
||||
[architecture]: https://docs.edgeless.systems/constellation/architecture/overview
|
||||
[certified]: https://www.cncf.io/certification/software-conformance/
|
||||
[Cilium]: https://cilium.io/
|
||||
[cla-assistant]: https://cla-assistant.io/edgelesssys/constellation
|
||||
[cluster-attestation]: https://docs.edgeless.systems/constellation/latest/#/architecture/attestation?id=cluster-attestation
|
||||
[community-license]: https://docs.edgeless.systems/constellation/latest/#/getting-started/license
|
||||
[cluster-attestation]: https://docs.edgeless.systems/constellation/architecture/attestation#cluster-attestation
|
||||
[community-license]: https://docs.edgeless.systems/constellation/overview/license
|
||||
[confidential-computing]: https://www.edgeless.systems/resources/confidential-computing/
|
||||
[confidential-kubernetes]: https://docs.edgeless.systems/constellation/latest/#/getting-started/confidential-kubernetes
|
||||
[confidential-kubernetes]: https://docs.edgeless.systems/constellation/overview/confidential-kubernetes
|
||||
[Constellation]: https://www.edgeless.systems/products/constellation/
|
||||
[constellation-product]: https://www.edgeless.systems/products/constellation/
|
||||
[contact]: https://www.edgeless.systems/contact/
|
||||
[deploy]: https://docs.edgeless.systems/constellation/latest/#/workflows/create
|
||||
[deploy]: https://docs.edgeless.systems/constellation/workflows/create
|
||||
[discord]: https://discord.gg/rH8QTH56JN
|
||||
[discord-badge]: https://img.shields.io/badge/chat-on%20Discord-blue
|
||||
[documentation]: https://docs.edgeless.systems/constellation/latest
|
||||
[e2eTestAzure]: https://github.com/edgelesssys/constellation/actions/workflows/e2e-test-azure.yml/badge.svg?branch=main
|
||||
[e2eTestGCP]: https://github.com/edgelesssys/constellation/actions/workflows/e2e-test-gcp.yml/badge.svg?branch=main
|
||||
[etcd-stacked]: https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/ha-topology/#stacked-etcd-topology
|
||||
[examples]: https://docs.edgeless.systems/constellation/latest/#/getting-started/examples
|
||||
[getting-started]: https://docs.edgeless.systems/constellation/latest/#/getting-started/install
|
||||
[examples]: https://docs.edgeless.systems/constellation/getting-started/examples
|
||||
[getting-started]: https://docs.edgeless.systems/constellation/getting-started
|
||||
[github-issues]: https://github.com/edgelesssys/constellation/issues/new/choose
|
||||
[go-report-card]: https://goreportcard.com/report/github.com/edgelesssys/constellation
|
||||
[go-report-card-badge]: https://goreportcard.com/badge/github.com/edgelesssys/constellation
|
||||
[images]: https://docs.edgeless.systems/constellation/latest/#/architecture/images?id=constellation-images
|
||||
[install]: https://docs.edgeless.systems/constellation/latest/#/getting-started/install
|
||||
[join-service]: https://docs.edgeless.systems/constellation/latest/#/architecture/components?id=joinservice
|
||||
[k8s-version-support]: https://docs.edgeless.systems/constellation/latest/#/architecture/versions?id=kubernetes-support-policy
|
||||
[key-management]: https://docs.edgeless.systems/constellation/latest/#/architecture/keys?id=constellation-managed-key-management
|
||||
[images]: https://docs.edgeless.systems/constellation/architecture/images#constellation-images
|
||||
[install]: https://docs.edgeless.systems/constellation/getting-started/install
|
||||
[join-service]: https://docs.edgeless.systems/constellation/architecture/components#joinservice
|
||||
[k8s-version-support]: https://docs.edgeless.systems/constellation/architecture/versions#kubernetes-support-policy
|
||||
[key-management]: https://docs.edgeless.systems/constellation/architecture/keys#constellation-managed-key-management
|
||||
[license]: https://github.com/edgelesssys/constellation/blob/master/LICENSE
|
||||
[license-badge]: https://img.shields.io/github/license/edgelesssys/constellation
|
||||
[linkedin]: https://www.linkedin.com/company/edgeless-systems/
|
||||
[network-encryption]: https://docs.edgeless.systems/constellation/latest/#/architecture/keys?id=network-encryption
|
||||
[network-encryption]: https://docs.edgeless.systems/constellation/architecture/keys#network-encryption
|
||||
[newsletter]: https://www.edgeless.systems/#newsletter-signup
|
||||
[node-attestation]: https://docs.edgeless.systems/constellation/latest/#/architecture/attestation?id=node-attestation
|
||||
[storage-encryption]: https://docs.edgeless.systems/constellation/latest/#/architecture/keys?id=storage-encryption
|
||||
[supply-chain]: https://docs.edgeless.systems/constellation/latest/#/architecture/attestation?id=chain-of-trust
|
||||
[troubleshooting]: https://docs.edgeless.systems/constellation/latest/#/workflows/troubleshooting
|
||||
[threat-model]: https://docs.edgeless.systems/constellation/latest/#/getting-started/threat-model
|
||||
[node-attestation]: https://docs.edgeless.systems/constellation/architecture/attestation#node-attestation
|
||||
[storage-encryption]: https://docs.edgeless.systems/constellation/architecture/keys#storage-encryption
|
||||
[supply-chain]: https://docs.edgeless.systems/constellation/architecture/attestation#chain-of-trust
|
||||
[troubleshooting]: https://docs.edgeless.systems/constellation/workflows/troubleshooting
|
||||
[threat-model]: https://docs.edgeless.systems/constellation/overview/security-benefits
|
||||
[twitter]: https://twitter.com/EdgelessSystems
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
[Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) for working with Kubernetes
|
||||
|
||||
For more information [follow our documentation.](https://docs.edgeless.systems/constellation/latest/#/getting-started/install)
|
||||
For more information [follow our documentation.](https://docs.edgeless.systems/constellation/getting-started/install)
|
||||
|
||||
Additionally, [Sonobuoy CLI is required.](https://github.com/vmware-tanzu/sonobuoy/releases)
|
||||
These tests results were produced using Sonobuoy v0.56.4.
|
||||
|
||||
@ -149,7 +149,7 @@ type AzureConfig struct {
|
||||
// Type of a node's state disk. The type influences boot time and I/O performance. See: https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#disk-type-comparison
|
||||
StateDiskType string `yaml:"stateDiskType" validate:"oneof=Premium_LRS Premium_ZRS Standard_LRS StandardSSD_LRS StandardSSD_ZRS"`
|
||||
// description: |
|
||||
// Authorize spawned VMs to access Azure API. See: https://docs.edgeless.systems/constellation/latest/#/getting-started/install?id=azure
|
||||
// Authorize spawned VMs to access Azure API. See: https://docs.edgeless.systems/constellation/getting-started/install#authorization
|
||||
UserAssignedIdentity string `yaml:"userAssignedIdentity" validate:"required"`
|
||||
// description: |
|
||||
// Resource group to use.
|
||||
@ -195,7 +195,7 @@ type GCPConfig struct {
|
||||
// Type of a node's state disk. The type influences boot time and I/O performance. See: https://cloud.google.com/compute/docs/disks#disk-types
|
||||
StateDiskType string `yaml:"stateDiskType" validate:"oneof=pd-standard pd-balanced pd-ssd"`
|
||||
// description: |
|
||||
// Path of service account key file. For needed service account roles, see https://constellation-docs.edgeless.systems/constellation/latest/#/getting-started/install?id=authorization
|
||||
// Path of service account key file. For needed service account roles, see https://constellation-docs.edgeless.systems/constellation/getting-started/install#authorization
|
||||
ServiceAccountKeyPath string `yaml:"serviceAccountKeyPath"`
|
||||
// description: |
|
||||
// Expected confidential VM measurements.
|
||||
|
||||
@ -228,8 +228,8 @@ func init() {
|
||||
AzureConfigDoc.Fields[5].Name = "userAssignedIdentity"
|
||||
AzureConfigDoc.Fields[5].Type = "string"
|
||||
AzureConfigDoc.Fields[5].Note = ""
|
||||
AzureConfigDoc.Fields[5].Description = "Authorize spawned VMs to access Azure API. See: https://docs.edgeless.systems/constellation/latest/#/getting-started/install?id=azure"
|
||||
AzureConfigDoc.Fields[5].Comments[encoder.LineComment] = "Authorize spawned VMs to access Azure API. See: https://docs.edgeless.systems/constellation/latest/#/getting-started/install?id=azure"
|
||||
AzureConfigDoc.Fields[5].Description = "Authorize spawned VMs to access Azure API. See: https://docs.edgeless.systems/constellation/getting-started/install#authorization"
|
||||
AzureConfigDoc.Fields[5].Comments[encoder.LineComment] = "Authorize spawned VMs to access Azure API. See: https://docs.edgeless.systems/constellation/getting-started/install#authorization"
|
||||
AzureConfigDoc.Fields[6].Name = "resourceGroup"
|
||||
AzureConfigDoc.Fields[6].Type = "string"
|
||||
AzureConfigDoc.Fields[6].Note = ""
|
||||
@ -309,8 +309,8 @@ func init() {
|
||||
GCPConfigDoc.Fields[5].Name = "serviceAccountKeyPath"
|
||||
GCPConfigDoc.Fields[5].Type = "string"
|
||||
GCPConfigDoc.Fields[5].Note = ""
|
||||
GCPConfigDoc.Fields[5].Description = "Path of service account key file. For needed service account roles, see https://constellation-docs.edgeless.systems/constellation/latest/#/getting-started/install?id=authorization"
|
||||
GCPConfigDoc.Fields[5].Comments[encoder.LineComment] = "Path of service account key file. For needed service account roles, see https://constellation-docs.edgeless.systems/constellation/latest/#/getting-started/install?id=authorization"
|
||||
GCPConfigDoc.Fields[5].Description = "Path of service account key file. For needed service account roles, see https://constellation-docs.edgeless.systems/constellation/getting-started/install#authorization"
|
||||
GCPConfigDoc.Fields[5].Comments[encoder.LineComment] = "Path of service account key file. For needed service account roles, see https://constellation-docs.edgeless.systems/constellation/getting-started/install#authorization"
|
||||
GCPConfigDoc.Fields[6].Name = "measurements"
|
||||
GCPConfigDoc.Fields[6].Type = "Measurements"
|
||||
GCPConfigDoc.Fields[6].Note = ""
|
||||
|
||||
Loading…
Reference in New Issue
Block a user