Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/stackit_alpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,6 @@ stackit alpha [flags]
### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)
* [stackit alpha vpc](./stackit_alpha_vpc.md) - Manages vpcs

60 changes: 60 additions & 0 deletions docs/stackit_alpha_bucket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## stackit alpha bucket

Manages objects in STACKIT Object Storage buckets (data plane)

### Synopsis

Manages objects in STACKIT Object Storage buckets.

Buckets and objects can be addressed with s3 URIs (s3://BUCKET[/KEY]) or
STACKIT Object Storage URLs in virtual hosted style
(https://BUCKET.object.storage.REGION.onstackit.cloud[/KEY]) or path style
(https://object.storage.REGION.onstackit.cloud/BUCKET[/KEY]).

Credentials (access key ID / secret access key) are required and can be provided
with the --access-key-id and --secret-access-key flags, the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID
and STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variables, or the config file.
Create credentials with 'stackit object-storage credentials create'.

```
stackit alpha bucket [flags]
```

### Examples

```
List all buckets
$ stackit alpha bucket ls

Upload a file to a bucket
$ stackit alpha bucket cp local/file.txt s3://my-bucket/file.txt
```

### Options

```
-h, --help[=true|false] Help for "stackit alpha bucket"
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha](./stackit_alpha.md) - Contains alpha STACKIT CLI commands
* [stackit alpha bucket cp](./stackit_alpha_bucket_cp.md) - Copies objects between local and Object Storage
* [stackit alpha bucket ls](./stackit_alpha_bucket_ls.md) - Lists buckets and objects
* [stackit alpha bucket mb](./stackit_alpha_bucket_mb.md) - Creates a bucket
* [stackit alpha bucket mv](./stackit_alpha_bucket_mv.md) - Moves objects between local and Object Storage
* [stackit alpha bucket presign](./stackit_alpha_bucket_presign.md) - Generates a presigned URL for an object
* [stackit alpha bucket rb](./stackit_alpha_bucket_rb.md) - Deletes a bucket
* [stackit alpha bucket rm](./stackit_alpha_bucket_rm.md) - Deletes objects

60 changes: 60 additions & 0 deletions docs/stackit_alpha_bucket_cp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## stackit alpha bucket cp

Copies objects between local and Object Storage

### Synopsis

Copies a single object or a directory tree between local storage and Object Storage.

One of SRC and DESTINATION must be a bucket URI (s3://BUCKET[/KEY]) or a STACKIT
Object Storage URL (https://BUCKET.object.storage.REGION.onstackit.cloud[/KEY])
and the other a local path.
Without --recursive, a single object is transferred.
With --recursive, all objects under the prefix (download) or all files under the
local directory (upload) are transferred.

```
stackit alpha bucket cp SRC DESTINATION [flags]
```

### Examples

```
Upload a file to a bucket
$ stackit alpha bucket cp local/file.txt s3://my-bucket/file.txt

Download a single object
$ stackit alpha bucket cp s3://my-bucket/file.txt local/file.txt

Upload a directory recursively
$ stackit alpha bucket cp ./local/dir s3://my-bucket/prefix/ --recursive

Download a prefix recursively
$ stackit alpha bucket cp s3://my-bucket/prefix/ ./local/dir --recursive
```

### Options

```
--access-key-id string Object Storage access key ID. Can also be set with the object_storage_access_key_id config key or the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID environment variable.
--endpoint string Object Storage API endpoint. Defaults to https://object.storage.<region>.onstackit.cloud. Can also be set with the object_storage_data_plane_custom_endpoint config key or the STACKIT_OBJECT_STORAGE_DATA_PLANE_CUSTOM_ENDPOINT environment variable.
-h, --help[=true|false] Help for "stackit alpha bucket cp"
--recursive[=true|false] Transfer a directory tree or all objects under a prefix
--secret-access-key string Object Storage secret access key. Can also be set with the object_storage_secret_access_key config key or the STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variable.
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)

55 changes: 55 additions & 0 deletions docs/stackit_alpha_bucket_ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## stackit alpha bucket ls

Lists buckets and objects

### Synopsis

Lists all buckets, or the contents of a bucket.

Without an argument, lists all buckets.
With a bucket URI (s3://BUCKET), lists the "directories" and objects at the bucket root.
With an object URI (s3://BUCKET/PREFIX), lists the "directories" and objects under the prefix.
With --recursive, lists all objects under the prefix flat, including all nested keys.

```
stackit alpha bucket ls [BUCKET_URI] [flags]
```

### Examples

```
List all buckets
$ stackit alpha bucket ls

List the contents of a bucket
$ stackit alpha bucket ls s3://my-bucket

Recursively list all objects under a prefix
$ stackit alpha bucket ls s3://my-bucket/path/to/ --recursive
```

### Options

```
--access-key-id string Object Storage access key ID. Can also be set with the object_storage_access_key_id config key or the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID environment variable.
--endpoint string Object Storage API endpoint. Defaults to https://object.storage.<region>.onstackit.cloud. Can also be set with the object_storage_data_plane_custom_endpoint config key or the STACKIT_OBJECT_STORAGE_DATA_PLANE_CUSTOM_ENDPOINT environment variable.
-h, --help[=true|false] Help for "stackit alpha bucket ls"
--recursive[=true|false] List all objects under the prefix recursively, including nested keys
--secret-access-key string Object Storage secret access key. Can also be set with the object_storage_secret_access_key config key or the STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variable.
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)

43 changes: 43 additions & 0 deletions docs/stackit_alpha_bucket_mb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## stackit alpha bucket mb

Creates a bucket

### Synopsis

Creates a bucket in STACKIT Object Storage.

```
stackit alpha bucket mb BUCKET_URI [flags]
```

### Examples

```
Create a bucket
$ stackit alpha bucket mb s3://my-bucket
```

### Options

```
--access-key-id string Object Storage access key ID. Can also be set with the object_storage_access_key_id config key or the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID environment variable.
--endpoint string Object Storage API endpoint. Defaults to https://object.storage.<region>.onstackit.cloud. Can also be set with the object_storage_data_plane_custom_endpoint config key or the STACKIT_OBJECT_STORAGE_DATA_PLANE_CUSTOM_ENDPOINT environment variable.
-h, --help[=true|false] Help for "stackit alpha bucket mb"
--secret-access-key string Object Storage secret access key. Can also be set with the object_storage_secret_access_key config key or the STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variable.
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)

57 changes: 57 additions & 0 deletions docs/stackit_alpha_bucket_mv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## stackit alpha bucket mv

Moves objects between local and Object Storage

### Synopsis

Moves a single object or a directory tree, then deletes the source.

One of SRC and DESTINATION must be a bucket URI (s3://BUCKET[/KEY]) or a STACKIT
Object Storage URL (https://BUCKET.object.storage.REGION.onstackit.cloud[/KEY])
and the other a local path.
Bucket-to-bucket moves use a server-side copy.
Without --recursive, a single object is moved.
With --recursive, all objects under the prefix (or all files under the local directory) are moved.

```
stackit alpha bucket mv SRC DESTINATION [flags]
```

### Examples

```
Move a file to a bucket
$ stackit alpha bucket mv local/file.txt s3://my-bucket/file.txt

Move an object to a new key
$ stackit alpha bucket mv s3://my-bucket/old/file.txt s3://my-bucket/new/file.txt

Move a prefix to another bucket recursively
$ stackit alpha bucket mv s3://src-bucket/prefix/ s3://dst-bucket/prefix/ --recursive
```

### Options

```
--access-key-id string Object Storage access key ID. Can also be set with the object_storage_access_key_id config key or the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID environment variable.
--endpoint string Object Storage API endpoint. Defaults to https://object.storage.<region>.onstackit.cloud. Can also be set with the object_storage_data_plane_custom_endpoint config key or the STACKIT_OBJECT_STORAGE_DATA_PLANE_CUSTOM_ENDPOINT environment variable.
-h, --help[=true|false] Help for "stackit alpha bucket mv"
--recursive[=true|false] Move a directory tree or all objects under a prefix
--secret-access-key string Object Storage secret access key. Can also be set with the object_storage_secret_access_key config key or the STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variable.
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)

48 changes: 48 additions & 0 deletions docs/stackit_alpha_bucket_presign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## stackit alpha bucket presign

Generates a presigned URL for an object

### Synopsis

Generates a presigned URL that grants time-limited read access to an object
without exposing the Object Storage credentials.

```
stackit alpha bucket presign BUCKET_URI [flags]
```

### Examples

```
Generate a presigned URL valid for 1 hour (default)
$ stackit alpha bucket presign s3://my-bucket/file.txt

Generate a presigned URL valid for 15 minutes
$ stackit alpha bucket presign s3://my-bucket/file.txt --expires 15m
```

### Options

```
--access-key-id string Object Storage access key ID. Can also be set with the object_storage_access_key_id config key or the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID environment variable.
--endpoint string Object Storage API endpoint. Defaults to https://object.storage.<region>.onstackit.cloud. Can also be set with the object_storage_data_plane_custom_endpoint config key or the STACKIT_OBJECT_STORAGE_DATA_PLANE_CUSTOM_ENDPOINT environment variable.
--expires duration Expiration of the presigned URL (e.g. 15m, 1h, 72h). Maximum: 7 days (default 1h0m0s)
-h, --help[=true|false] Help for "stackit alpha bucket presign"
--secret-access-key string Object Storage secret access key. Can also be set with the object_storage_secret_access_key config key or the STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variable.
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)

43 changes: 43 additions & 0 deletions docs/stackit_alpha_bucket_rb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## stackit alpha bucket rb

Deletes a bucket

### Synopsis

Deletes a bucket in STACKIT Object Storage. The bucket must be empty.

```
stackit alpha bucket rb BUCKET_URI [flags]
```

### Examples

```
Delete an empty bucket
$ stackit alpha bucket rb s3://my-bucket
```

### Options

```
--access-key-id string Object Storage access key ID. Can also be set with the object_storage_access_key_id config key or the STACKIT_OBJECT_STORAGE_ACCESS_KEY_ID environment variable.
--endpoint string Object Storage API endpoint. Defaults to https://object.storage.<region>.onstackit.cloud. Can also be set with the object_storage_data_plane_custom_endpoint config key or the STACKIT_OBJECT_STORAGE_DATA_PLANE_CUSTOM_ENDPOINT environment variable.
-h, --help[=true|false] Help for "stackit alpha bucket rb"
--secret-access-key string Object Storage secret access key. Can also be set with the object_storage_secret_access_key config key or the STACKIT_OBJECT_STORAGE_SECRET_ACCESS_KEY environment variable.
```

### Options inherited from parent commands

```
-y, --assume-yes[=true|false] If set, skips all confirmation prompts
--async[=true|false] If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit alpha bucket](./stackit_alpha_bucket.md) - Manages objects in STACKIT Object Storage buckets (data plane)

Loading
Loading