Search…
Persistent, pluggable storage
Learn about Cased's persistent storage layer and how to set it up for custom deployments.

Overview

Cased Shell comes with persistent/nonvolatile storage automatically when using our Cased Shell Terraform Module to deploy an instance. It automatically creates a private, encrypted S3 bucket and uses it to store application data related to your Cased Shell instance. All data is encrypted at rest and in transit using a per-instance Amazon KMS key.
If you do not configure persistent storage, Cased Shell will simply fallback to non-persistent, local storage for things like your SSH recordings.

Custom AWS deployment

If you are not deploying Cased Shell with our Terraform Module all you have to do is set the following environment variables as follows.
  • STORAGE_BACKEND: set to s3 to store data on s3
  • STORAGE_S3_BUCKET: set to the name of a bucket dedicated for this purpose
  • STORAGE_S3_ACCESS_KEY_ID: set to the access key ID of a user that can read and write objects from the above bucket
  • STORAGE_S3_SECRET_ACCESS_KEY: set to the secret access key ID of a user that can read and write objects from the above bucket
  • STORAGE_S3_REGION: set to the region containing the bucket:
  • STORAGE_S3_ENDPOINT: (advanced) if using a custom s3 backend, set this value to its API endpoint (http://minio:9000)
  • STORAGE_S3_SIGNATURE_VERSION: (advanced) if using a custom s3 backend, set this value to the signature version in use (s3v4)

Custom Google Cloud deployment

Cased uses the official Google Cloud client directly so credentials are automatically managed using this pattern.
1
gsutil mb gs://cased-shell-EXAMPLE
Copied!
Grant the service account the objectAdmin role on the bucket:
1
gsutil iam ch \
2
serviceAccount:[email protected]:objectAdmin,legacyBucketReader \
3
gs://cased-shell-EXAMPLE
Copied!
Add the bucket name to the environment:
1
echo "STORAGE_GOOGLE_CLOUD_BUCKET=cased-shell-EXAMPLE" >> .env
2
echo "STORAGE_BACKEND=gcs" >> .env
Copied!
Now deploy again:
1
gcloud run deploy cased-shell \
2
--source=. \
3
--region=us-central1 \
4
--service-account=cased-shell \
5
--port=8888 \
6
--allow-unauthenticated \
7
--vpc-connector=cased-shell-vpc-connector \
8
--set-env-vars="$(cat .env | tr '\n' ',')"
Copied!