Skip to content

Commit

Permalink
update docs for azblob profile storage
Browse files Browse the repository at this point in the history
  • Loading branch information
Roy Razon committed Feb 6, 2024
1 parent aba0d26 commit bd5d602
Show file tree
Hide file tree
Showing 29 changed files with 551 additions and 1,412 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,9 +218,9 @@ A public Docker/OCI image is available: `ghcr.io/livecycle/preevy/tunnel-server`

## CI Integration

Preevy is designed to work seamlessly with your CI, allowing you to easily import a shared preview profile in AWS S3 and Google Cloud Storage (GCS).
Preevy is designed to work seamlessly with your CI, by importing a shared preview profile from [AWS S3](https://aws.amazon.com/s3/) [Google Cloud Storage (GCS)](https://cloud.google.com/storage/) and [Azure Blob Storage (AZBlob)](https://azure.microsoft.com/en-us/products/storage/blobs/).

Profiles are created using `preevy init`. Choose a S3/GCS URL for storing the profile - Preevy will create a bucket if one doesn't exist.
Profiles are created using `preevy init`. Choose a S3/GCS/AZBlob URL for storing the profile - Preevy will create a bucket if one doesn't exist.

If you already have a locally stored Preevy Profile, it can be migrated to remote storage using [`preevy profile cp`](https://github.com/livecycle/preevy/blob/main/packages/cli/docs/profile.md#preevy-profile-cp)

Expand Down
1,025 changes: 15 additions & 1,010 deletions packages/cli/README.md

Large diffs are not rendered by default.

61 changes: 37 additions & 24 deletions packages/cli/docs/down.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,26 @@ Delete preview environments

```
USAGE
$ preevy down [--json] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--enable-plugin
<value>] [--disable-plugin <value>] [--profile <value>] [-d lightsail|gce|azure|kube-pod] [--lightsail-region
<value>] [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
[--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-context <value>] [--kube-pod-template
<value>] [--id <value>] [--force] [--wait] [--github-token <value>] [--github-repo <value>] [--github-pull-request
<value>] [--github-pr-comment-template-file <value>] [--github-add-build-cache] [--github-pr-comment-enabled
auto|no|always]
$ preevy down [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [-d
lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone <value>]
[--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>] [--kube-pod-kubeconfig
<value>] [--kube-pod-context <value>] [--lightsail-availability-zone <value>] [--lightsail-bundle-id
nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0] [--gce-machine-type <value>]
[--azure-vm-size <value>] [--kube-pod-template <value>] [--kube-pod-server-side-apply] [--kube-pod-storage-class
<value>] [--kube-pod-storage-size <value>] [--id <value>] [--force] [--wait] [--github-token <value>] [--github-repo
<value>] [--github-pull-request <value>] [--github-pr-comment-template-file <value>] [--github-add-build-cache]
[--github-pr-comment-enabled auto|no|always]
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--force Do not error if the environment is not found
--id=<value> Environment id
--profile=<value> Run in a specific profile context (either an alias or a URL)
--wait Wait for resource deletion to complete. If false (the default), the deletion will be started
but not waited for
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--force Do not error if the environment is not found
--id=<value> Environment id
--profile=<value> Run in a specific profile context (either an alias or a URL)
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
--wait Wait for resource deletion to complete. If false (the default), the deletion will be
started but not waited for
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand All @@ -39,11 +43,13 @@ GLOBAL FLAGS
AZURE DRIVER FLAGS
--azure-region=<value> Microsoft Azure region in which resources will be provisioned
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-subscription-id=<value> Microsoft Azure Subscription ID
--azure-vm-size=<value> [default: Standard_B2s] Machine type to be provisioned
GCE DRIVER FLAGS
--gce-project-id=<value> Google Cloud project ID
--gce-zone=<value> Google Cloud zone in which resources will be provisioned
--gce-machine-type=<value> Machine type to be provisioned
--gce-project-id=<value> Google Cloud project ID
--gce-zone=<value> Google Cloud zone in which resources will be provisioned
GITHUB INTEGRATION FLAGS
--github-add-build-cache Add github cache to the build
Expand All @@ -56,14 +62,21 @@ GITHUB INTEGRATION FLAGS
--github-token=<value> GitHub token with write access to the repo
KUBE-POD DRIVER FLAGS
--kube-pod-context=<value> kubeconfig context name (will load config from defaults if not specified)
--kube-pod-kubeconfig=<value> Path to kubeconfig file (will load config from defaults if not specified)
--kube-pod-namespace=<value> [default: default] Kubernetes namespace in which resources will be provisioned (needs
to exist)
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
--kube-pod-context=<value> kubeconfig context name (will load config from defaults if not specified)
--kube-pod-kubeconfig=<value> Path to kubeconfig file (will load config from defaults if not specified)
--kube-pod-namespace=<value> [default: default] Kubernetes namespace in which resources will be provisioned
(needs to exist)
--[no-]kube-pod-server-side-apply Use server side apply to create Kubernetes resources
--kube-pod-storage-class=<value> Storage class to use for Pod data volume
--kube-pod-storage-size=<value> [default: 5] Size of Pod data volume in GiB
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<value> AWS region in which resources will be provisioned
--lightsail-availability-zone=<value> AWS availability zone to provision resources in region
--lightsail-bundle-id=<option> Lightsail bundle ID (size of instance) to provision. Default: medium_2_0
<options:
nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
Delete preview environments
Expand All @@ -75,4 +88,4 @@ FLAG DESCRIPTIONS
If not specified, will detect from the current Git context
```

_See code: [src/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.58/src/commands/down.ts)_
_See code: [src/commands/down.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/down.ts)_
2 changes: 1 addition & 1 deletion packages/cli/docs/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ DESCRIPTION
Display help for preevy.
```

_See code: [src/commands/help.ts](https://github.com/livecycle/preevy/blob/v0.0.58/src/commands/help.ts)_
_See code: [src/commands/help.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/help.ts)_
9 changes: 5 additions & 4 deletions packages/cli/docs/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ Initialize or import a new profile

```
USAGE
$ preevy init [PROFILE-ALIAS] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>]
[--enable-plugin <value>] [--disable-plugin <value>] [--from <value>]
$ preevy init [PROFILE-ALIAS] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory
<value>] [-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--from <value>]
ARGUMENTS
PROFILE-ALIAS Name of the profile
FLAGS
--from=<value> Import profile from existing path
--from=<value> Import profile from existing path
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand All @@ -32,4 +33,4 @@ DESCRIPTION
Initialize or import a new profile
```

_See code: [src/commands/init.ts](https://github.com/livecycle/preevy/blob/v0.0.58/src/commands/init.ts)_
_See code: [src/commands/init.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/init.ts)_
14 changes: 8 additions & 6 deletions packages/cli/docs/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ Login to the Livecycle SaaS

```
USAGE
$ preevy login [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--enable-plugin <value>]
[--disable-plugin <value>] [--lc-auth-url <value>] [--lc-api-url <value>] [--lc-client-id <value>]
$ preevy login [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>] [-p
<value>] [--enable-plugin <value>] [--disable-plugin <value>] [--lc-auth-url <value>] [--lc-api-url <value>]
[--lc-client-id <value>]
FLAGS
--lc-api-url=<value> [default: https://app.livecycle.run] The Livecycle API URL'
--lc-auth-url=<value> [default: https://auth.livecycle.dev] The login URL
--lc-client-id=<value> [default: BHXcVtapfKPEpZtYO3AJ2Livmz6j7xK0] The client ID for the OAuth app
--lc-api-url=<value> [default: https://app.livecycle.run] The Livecycle API URL'
--lc-auth-url=<value> [default: https://auth.livecycle.dev] The login URL
--lc-client-id=<value> [default: BHXcVtapfKPEpZtYO3AJ2Livmz6j7xK0] The client ID for the OAuth app
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand All @@ -31,4 +33,4 @@ DESCRIPTION
Login to the Livecycle SaaS
```

_See code: [src/commands/login.ts](https://github.com/livecycle/preevy/blob/v0.0.58/src/commands/login.ts)_
_See code: [src/commands/login.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/login.ts)_
38 changes: 19 additions & 19 deletions packages/cli/docs/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,28 @@ Show logs for an existing environment

```
USAGE
$ preevy logs [SERVICES] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--enable-plugin
<value>] [--disable-plugin <value>] [--profile <value>] [-d lightsail|gce|azure|kube-pod] [--lightsail-region
<value>] [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
[--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-context <value>] [--kube-pod-template
<value>] [--id <value>] [--follow] [--tail <value>] [--no-log-prefix] [--timestamps] [--since <value>] [--until
<value>]
$ preevy logs [SERVICES] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [-d
lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone <value>]
[--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>] [--kube-pod-kubeconfig
<value>] [--kube-pod-context <value>] [--id <value>] [--follow] [--tail <value>] [--no-log-prefix] [--timestamps]
[--since <value>] [--until <value>]
ARGUMENTS
SERVICES Service name(s). If not specified, will show all services
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--follow Follow log output
--id=<value> Environment id
--no-log-prefix Don't print log prefix in logs
--profile=<value> Run in a specific profile context (either an alias or a URL)
--since=<value> Show logs since timestamp
--tail=<value> Number of lines to show from the end of the logs for each container (default: all)
--timestamps Show timestamps
--until=<value> Show logs before timestamp
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--follow Follow log output
--id=<value> Environment id
--no-log-prefix Don't print log prefix in logs
--profile=<value> Run in a specific profile context (either an alias or a URL)
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
--since=<value> Show logs since timestamp
--tail=<value> Number of lines to show from the end of the logs for each container (default: all)
--timestamps Show timestamps
--until=<value> Show logs before timestamp
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand All @@ -43,7 +44,7 @@ GLOBAL FLAGS
AZURE DRIVER FLAGS
--azure-region=<value> Microsoft Azure region in which resources will be provisioned
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-subscription-id=<value> Microsoft Azure Subscription ID
GCE DRIVER FLAGS
--gce-project-id=<value> Google Cloud project ID
Expand All @@ -54,7 +55,6 @@ KUBE-POD DRIVER FLAGS
--kube-pod-kubeconfig=<value> Path to kubeconfig file (will load config from defaults if not specified)
--kube-pod-namespace=<value> [default: default] Kubernetes namespace in which resources will be provisioned (needs
to exist)
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<value> AWS region in which resources will be provisioned
Expand All @@ -69,4 +69,4 @@ FLAG DESCRIPTIONS
If not specified, will detect from the current Git context
```

_See code: [src/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.58/src/commands/logs.ts)_
_See code: [src/commands/logs.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/logs.ts)_
24 changes: 12 additions & 12 deletions packages/cli/docs/ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,18 @@ List preview environments

```
USAGE
$ preevy ls [--json] [-D] [-f <value>] [--system-compose-file <value>] [-p <value>] [--enable-plugin
<value>] [--disable-plugin <value>] [--profile <value>] [-d lightsail|gce|azure|kube-pod] [--lightsail-region
<value>] [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
[--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-context <value>] [--kube-pod-template
<value>] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml
| | ] [--sort <value>]
$ preevy ls [--json] [-D] [-f <value>] [--system-compose-file <value>] [--project-directory <value>]
[-p <value>] [--enable-plugin <value>] [--disable-plugin <value>] [--profile <value>] [-d
lightsail|gce|azure|kube-pod] [--lightsail-region <value>] [--gce-project-id <value>] [--gce-zone <value>]
[--azure-region <value>] [--azure-subscription-id <value>] [--kube-pod-namespace <value>] [--kube-pod-kubeconfig
<value>] [--kube-pod-context <value>] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
--no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--profile=<value> Run in a specific profile context (either an alias or a URL)
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
--profile=<value> Run in a specific profile context (either an alias or a URL)
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose file)
GLOBAL FLAGS
-D, --debug Enable debug logging
Expand All @@ -45,7 +46,7 @@ OUTPUT FLAGS
AZURE DRIVER FLAGS
--azure-region=<value> Microsoft Azure region in which resources will be provisioned
--azure-subscription-id=<value> Microsoft Azure subscription id
--azure-subscription-id=<value> Microsoft Azure Subscription ID
GCE DRIVER FLAGS
--gce-project-id=<value> Google Cloud project ID
Expand All @@ -56,7 +57,6 @@ KUBE-POD DRIVER FLAGS
--kube-pod-kubeconfig=<value> Path to kubeconfig file (will load config from defaults if not specified)
--kube-pod-namespace=<value> [default: default] Kubernetes namespace in which resources will be provisioned (needs
to exist)
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-region=<value> AWS region in which resources will be provisioned
Expand All @@ -65,4 +65,4 @@ DESCRIPTION
List preview environments
```

_See code: [src/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.58/src/commands/ls.ts)_
_See code: [src/commands/ls.ts](https://github.com/livecycle/preevy/blob/v0.0.60/src/commands/ls.ts)_
Loading

0 comments on commit bd5d602

Please sign in to comment.