Skip to content

Latest commit

 

History

History
106 lines (65 loc) · 2.89 KB

README.md

File metadata and controls

106 lines (65 loc) · 2.89 KB
Raw

Deploying S3 Static Site Deployment

An interactive Op that deploys a static site to a public S3 bucket.

Requirements

To run this or any other Op, install the Ops Platform.

Find information about how to run and build Ops via the Ops Platform Documentation.

This Op also requires AWS credentials to work with your account. Here's what you'll need before running this Op the first time:

  • AWS Access Key Id: via the AWS Management Console:
    • AWS Management Console -> Security Credentials -> Access Keys
  • AWS Access Key Secret: via the AWS Management Console:
    • AWS Management Console -> Security Credentials -> Access Keys

Usage

The very first time you run this Op, you'll want to set up the appropriate secrets so you don't have to manually enter it in each time.

To set secrets, run:

ops secrets:set

Follow the prompts and enter in the name of the key and its value. This will save the secret so it can be accessed the next time you use the Op.

This will set the secret to the team which you're currently on (The default is your personal team which is the same as your username). You can also check which team you're currently on by running:

ops whoami

In order to use the secrets you just set, the Op needs to be published to this team.

To run the public version of the Op in the terminal, enter in:

ops run @cto.ai/static-site

To run the public version of the Op in a public Slack channel:

/ops run cto.ai/static-site

Local Development / Running from Source

1. Clone the static-site:

git clone <git url>

2. Navigate into the directory and build the image:

cd static-site && ops build .

3. Run the Op from your current working directory with:

ops run .

4. To publish the Op to your team:

ops publish .

To run the Op in Slack, make sure that you have the CTO.ai Bot installed in your Slack workspace.

To run the Op in a Slack channel, enter: /ops run static-site

Debugging Issues

When submitting issues or requesting help, be sure to also include the version information. To get your Ops version run:

ops -v

You can reach us at the CTO.ai Community Slack or email us at support@cto.ai.

AWS Documents

Contributing

See the Contributing Docs for more information

Contributors

LICENSE

MIT