Add package design goals to CLI package documentation

Signed-off-by: Daniel Weiße <dw@edgeless.systems>
This commit is contained in:
Daniel Weiße 2023-08-08 15:18:36 +02:00 committed by Daniel Weiße
parent 946942ba68
commit 99c579b45a
10 changed files with 56 additions and 135 deletions

View file

@ -5,16 +5,17 @@ SPDX-License-Identifier: AGPL-3.0-only
*/
/*
Package cloudcmd provides executable command for the CLI.
Package cloudcmd provides executable commands for the CLI.
This package focuses on the interaction with the cloud provider.
It separates the cloud provider specific code from the rest of the CLI, and
provides a common interface for all cloud providers.
Exported functions must not be cloud provider specific, but rather take a
cloudprovider.Provider as an argument.
cloudprovider.Provider as an argument, perform CSP specific logic, and return a universally usable result.
User interaction happens in the cmd package, and should not happen or pass through
It is used by the "cmd" to handle creation of cloud resources and other CSP specific interactions.
User interaction happens in the "cmd" package, and should not happen or pass through
this package.
The backend to this package is currently provided by the terraform package.