mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-05-19 22:50:34 -04:00
dev-docs: Go package docs (#958)
* Remove unused package * Add Go package docs to most packages Signed-off-by: Daniel Weiße <dw@edgeless.systems> Signed-off-by: Fabian Kammel <fk@edgeless.systems> Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> Co-authored-by: Fabian Kammel <fk@edgeless.systems>
This commit is contained in:
parent
b7740723ac
commit
690b50b29d
118 changed files with 735 additions and 750 deletions
|
@ -4,6 +4,24 @@ Copyright (c) Edgeless Systems GmbH
|
|||
SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
/*
|
||||
Package client provides a client for the versions API.
|
||||
|
||||
The client needs to be authenticated with AWS. It should be used in internal
|
||||
development and CI tools for administrative tasks. For just fetching information
|
||||
from the API, use the fetcher package instead.
|
||||
|
||||
Needed IAM permissions for read mode:
|
||||
- "s3:GetObject"
|
||||
- "s3:ListBucket"
|
||||
|
||||
Additional needed IAM permissions for write mode:
|
||||
- "s3:PutObject"
|
||||
- "s3:DeleteObject"
|
||||
- "cloudfront:CreateInvalidation"
|
||||
|
||||
Thread-safety of the bucket is not guaranteed. The client is not thread-safe.
|
||||
*/
|
||||
package client
|
||||
|
||||
import (
|
||||
|
@ -30,20 +48,6 @@ import (
|
|||
)
|
||||
|
||||
// Client is the client for the versions API.
|
||||
//
|
||||
// The client needs to be authenticated with AWS. It is the interface that should
|
||||
// be used in internal development and CI tools.
|
||||
//
|
||||
// Needed IAM permissions for read mode:
|
||||
// - "s3:GetObject"
|
||||
// - "s3:ListBucket"
|
||||
//
|
||||
// Additional needed IAM permissions for write mode:
|
||||
// - "s3:PutObject"
|
||||
// - "s3:DeleteObject"
|
||||
// - "cloudfront:CreateInvalidation"
|
||||
//
|
||||
// Thread-safety of the bucket is not guaranteed. The client is not thread-safe.
|
||||
type Client struct {
|
||||
config aws.Config
|
||||
cloudfrontClient *cloudfront.Client
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue