using-sdk

README

Aegis

Use Case: Leveraging Aegis SDK

This example demonstrates how to use Aegis SDK along with your workload.

When you use Aegis SDK, you can communicate with Aegis Safe directly and fetch the secrets to your workload whenever you need them.

This approach provides a great deal of flexibility, enabling you to make customizations to your code as needed. While adding the Aegis SDK as a dependency may require some extra effort, it also opens up a range of features and capabilities that will benefit your project in the long run.

Video Tutorials Anyone?

Watch Aegis Showcase to learn how to use Aegis hands-on.

If any of the instructions provided here are unclear, the video tutorials will help explain them in much greater detail. Each video is designed around a particular topic to keep it concise and to-the-point.

Deployment Options

To follow this use case, you can either locally build and deploy the container images; or you can pull and use pre-deployed images from Docker Hub.

The following sections describe both of these approaches respectively.

Local Deployment

# Switch to the project folder:
cd $WORKSPACE/aegis 
# Build everything locally:
make build-local
# Deploy the use case:
make example-sdk-deploy-local
# Switch to this use case’s folder:
cd $WORKSPACE/aegis/examples/using-sdk
# Register a secret:
./register.sh
# Tail the workload’s logs and verify that the secret is there:
./tail.sh

Using Pre-Deployed Images

If you don’t want to build the container images locally, you can use pre-deployed container images.

# Switch to the project folder:
cd $WORKSPACE/aegis 
# Deploy the use case from the pre-built image.
make example-sdk-deploy
# Switch to this use case’s folder:
cd $WORKSPACE/aegis/examples/using-sdk
# Register a secret:
./register.sh
# Tail the workload’s logs and verify that the secret is there:
./tail.sh