Skip to content

Latest commit

 

History

History
157 lines (106 loc) · 6.36 KB

README.md

File metadata and controls

157 lines (106 loc) · 6.36 KB
Raw

LocalStack - A fully functional local cloud stack

LocalStack Helm Charts

Helm charts for LocalStack.

Pipeline Status Twitter

LocalStack provides an easy-to-use test/mocking framework for developing Cloud applications.

Overview • Changelog • Contributing • Get In Touch •
–
📖 Docs • 💻 Pro version • ☑️ Feature coverage

Overview

LocalStack 💻 is a cloud service emulator that runs in a single container on your laptop or in your CI environment. With LocalStack, you can run your AWS applications or Lambdas entirely on your local machine without connecting to a remote cloud provider! Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow.

LocalStack supports a growing number of AWS services, like AWS Lambda, S3, Dynamodb, Kinesis, SQS, SNS, and many more! The Pro version of LocalStack supports additional APIs and advanced features. You can find a comprehensive list of supported APIs on our ☑️ Feature Coverage page.

LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack's Cloud Developer Tools for more information.

TL;DR

$ helm repo add localstack https://localstack.github.io/helm-charts
$ helm search repo <keyword>
$ helm install <name> localstack/<chart>

Before you begin

Prerequisites

  • Kubernetes 1.19+
  • Helm 3.2.0+

Setup a Kubernetes Cluster

For setting up Kubernetes refer to the Kubernetes getting started guide.

Install Helm

Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.

To install Helm, refer to the Helm install guide and ensure that the helm binary is in the PATH of your shell.

Add Repo

The following command allows you to download and install all the charts from this repository:

$ helm repo add localstack https://localstack.github.io/helm-charts

Using Helm

Once you have installed the Helm client, you can deploy a Helm chart into a Kubernetes cluster.

Please refer to the Quick Start guide if you wish to get running in just a few commands, otherwise the Using Helm Guide provides detailed instructions on how to use the Helm client to manage packages on your Kubernetes cluster.

Useful Helm Client Commands:

  • View available charts: helm search repo
  • Install a chart: helm install <name> localstack/<chart>
  • Upgrade your application: helm upgrade

Customization

The helm chart can be customized with Helm override files (the -f/--values) flag. A yaml file can be provided to override the default settings in the default values.yml.

A common customisation is to specify the LocalStack pod resource requests and limits. In particular, AWS EKS on Fargate commonly terminates LocalStack pods with the default resource requests. Consider adding the following section to your customization file:

resources:
  requests:
    cpu: 1
    memory: 1Gi
  limits:
    cpu: 2
    memory: 2Gi

Using the chart in OpenShift

Running LocalStack on OpenShift requires specific Security Context Constraints (SCC) to be applied to ensure proper deployment and operation. In the OpenShift Container Platform, you can use SCCs to control permissions for the pods in your cluster.

Default SCCs are created during installation and when you install some Operators or other components. As a cluster administrator, you can also create your own SCCs.

The cluster contains several default security context constraints (SCCs). The available Security Context Constraints are:

  • anyuid
  • hostaccess
  • hostmount-anyuid
  • hostnetwork
  • node-exporter
  • nonroot
  • privileged
  • restricted

Example:

role:
  extraRoles:
    - apiGroups: ["security.openshift.io"]
      resources: ["securitycontextconstraints"]
      resourceNames: ["anyuid"]
      verbs: ["use"]

For a more comprehensive overview, see the official SCC documentation: OpenShift SCCs

Change Log

Please refer to GitHub releases to see the complete list of changes for each release.

Contributing

If you are interested in contributing to LocalStack:

We are thankful for all the contributions and feedback we receive.

Get In Touch

To get in touch with LocalStack team for bugs/feature requests, support questions or general discussions, please use:

License

This version of LocalStack is released under the Apache License, Version 2.0 (see LICENSE.txt).