k8s-unleash

Unleash is a open source feature flag & toggle system, that gives you a great overview over all feature toggles across all your applications and services. It comes with official client implementations for Java, Node.js, Go, Ruby, Python and .NET Core.

Design

For detailed information, check out our Operator Guide for this bundle.

Usage

Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the Massdriver platform.

What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in Massdriver. Read more here.

Bundle

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

autoscaling (object)
- enabled (boolean): Default: False.
database (object)
- name (string): The name of the database to use. Note: this database must already exist! Default: unleash.
ingress (object): Settings to enable and configure internet access to Unleash.
- enabled (boolean): Enabling this will expose unleash on the public internet. Default: False.
namespace (string): The kubernetes namespace to install unleash into. Default: unleash.
resources (object)
- enable_limits (boolean): Enabling this will set resource limits in addition to the requests (values will be the same as requested values). Default: False.
- requests (object)
  - cpu (number): The expected CPU cores required for this application. Fractional numbers are allowed (0.5 is one half of a CPU core). Minimum: 0.001.
  - memory (integer): The expected Memory resources required for this application.

Connections

Connections from other bundles that this bundle depends on.

View

Properties

kubernetes_cluster (object): Kubernetes cluster authentication and cloud-specific configuration. Cannot contain additional properties.
- data (object)
  - authentication (object)
    - cluster (object)
      - certificate-authority-data (string)
      - server (string)
    - user (object)
      - token (string)
  - infrastructure (object): Cloud specific Kubernetes configuration data.
    - One of
      - AWS EKS infrastructure configobject: . Cannot contain additional properties.
        
        arn (string): Amazon Resource Name.
        
        Examples:
        
        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
        
        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
        
        oidc_issuer_url (string): An HTTPS endpoint URL.
        
        Examples:
        
        "https://example.com/some/path"
        
        "https://massdriver.cloud"
      - Infrastructure Configobject: Azure AKS Infrastructure Configuration. Cannot contain additional properties.
        
        ari (string): Azure Resource ID.
        
        Examples:
        
        "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
        
        oidc_issuer_url (string)
      - GCP Infrastructure GRNobject: Minimal GCP Infrastructure Config. Cannot contain additional properties.
        
        grn (string): GCP Resource Name (GRN).
        
        Examples:
        
        "projects/my-project/global/networks/my-global-network"
        
        "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
        
        "projects/my-project/topics/my-pubsub-topic"
        
        "projects/my-project/subscriptions/my-pubsub-subscription"
        
        "projects/my-project/locations/us-west2/instances/my-redis-instance"
        
        "projects/my-project/locations/us-west2/clusters/my-gke-cluster"
- specs (object)
  - aws (object): .
    - region (string): AWS Region to provision in.
      
      Examples:
      "us-west-2"
  - azure (object): .
    - region (string): Select the Azure region you'd like to provision your resources in.
  - gcp (object): .
    - project (string)
    - region (string): The GCP region to provision resources in.
      
      Examples:
      "us-east1"
      "us-east4"
      "us-west1"
      "us-west2"
      "us-west3"
      "us-west4"
      "us-central1"
  - kubernetes (object): Kubernetes distribution and version specifications.
    - cloud (string): Must be one of: ['aws', 'gcp', 'azure'].
    - distribution (string): Must be one of: ['eks', 'gke', 'aks'].
    - platform_version (string)
    - version (string)
postgresql_authentication (object): Authentication parameters for a PostgreSQL database. Cannot contain additional properties.
- data (object): Cannot contain additional properties.
  - authentication (object)
    - hostname (string)
    - password (string)
    - port (integer): Port number. Minimum: 0. Maximum: 65535.
    - username (string)
  - infrastructure (object): Cloud specific PostgreSQL configuration data.
    - One of
      - AWS Infrastructure ARNobject: Minimal AWS Infrastructure Config. Cannot contain additional properties.
        
        arn (string): Amazon Resource Name.
        
        Examples:
        
        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
        
        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
      - GCP Infrastructure Nameobject: GCP Infrastructure Config For Resources With A Name Not A GRN. Cannot contain additional properties.
        
        name (string): Name Of GCP Resource.
        
        Examples:
        
        "my-cloud-function"
        
        "my-sql-instance"
      - Azure Infrastructure Resource IDobject: Minimal Azure Infrastructure Config. Cannot contain additional properties.
        
        ari (string): Azure Resource ID.
        
        Examples:
        
        "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
      - Kuberenetes infrastructure configobject: . Cannot contain additional properties.
        
        kubernetes_namespace (string)
        
        kubernetes_service (string)
  - security (object): TBD.
    - Any of
      - AWS Security informationobject: Informs downstream services of network and/or IAM policies. Cannot contain additional properties.
        
        iam (object): IAM Policies. Cannot contain additional properties.
        
        ^[a-z]+[a-z_]*[a-z]+$ (object)
        
        policy_arn (string): AWS IAM policy ARN.
        
        Examples:
        
        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
        
        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
        
        identity (object): For instances where IAM policies must be attached to a role attached to an AWS resource, for instance AWS Eventbridge to Firehose, this attribute should be used to allow the downstream to attach it's policies (Firehose) directly to the IAM role created by the upstream (Eventbridge). It is important to remember that connections in massdriver are one way, this scheme perserves the dependency relationship while allowing bundles to control the lifecycles of resources under it's management. Cannot contain additional properties.
        
        role_arn (string): ARN for this resources IAM Role.
        
        Examples:
        
        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
        
        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
        
        network (object): AWS security group rules to inform downstream services of ports to open for communication. Cannot contain additional properties.
        
        ^[a-z-]+$ (object)
        
        arn (string): Amazon Resource Name.
        
        Examples:
        
        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"
        
        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
        
        port (integer): Port number. Minimum: 0. Maximum: 65535.
        
        protocol (string): Must be one of: ['tcp', 'udp'].
      - Securityobject: Azure Security Configuration. Cannot contain additional properties.
        
        iam (object): IAM Roles And Scopes. Cannot contain additional properties.
        
        ^[a-z]+[a-z_]*[a-z]$ (object)
        
        role: Azure Role.
        
        Examples:
        
        "Storage Blob Data Reader"
        
        scope (string): Azure IAM Scope.
      - Securityobject: GCP Security Configuration. Cannot contain additional properties.
        
        iam (object): IAM Roles And Conditions. Cannot contain additional properties.
        
        ^[a-z]+[a-z_]*[a-z]$ (object)
        
        condition (string): GCP IAM Condition.
        
        role: GCP Role.
        
        Examples:
        
        "roles/owner"
        
        "roles/redis.editor"
        
        "roles/storage.objectCreator"
        
        "roles/storage.legacyObjectReader"
- specs (object): Cannot contain additional properties.
  - aws (object): .
    - region (string): AWS Region to provision in.
      
      Examples:
      "us-west-2"
  - azure (object): .
    - region (string): Select the Azure region you'd like to provision your resources in.
  - gcp (object): .
    - project (string)
    - region (string): The GCP region to provision resources in.
      
      Examples:
      "us-east1"
      "us-east4"
      "us-west1"
      "us-west2"
      "us-west3"
      "us-west4"
      "us-central1"
  - rdbms (object): Common metadata for relational databases.
    - engine (string): The type of database server.
      
      Examples:
      "postgresql"
      "mysql"
    - engine_version (string): The cloud provider's database version.
      
      Examples:
      "5.7.mysql_aurora.2.03.2"
    - version (string): The database version. Default: ``.
      
      Examples:
      "12.2"
      "5.7"
    Examples:
```
{
    "engine": "postgresql",
    "engine_version": "10.14",
    "version": "10.14"
}
```
```
{
    "engine": "mysql",
    "engine_version": "5.7.mysql_aurora.2.03.2",
    "version": "5.7"
}
```

Artifacts

Resources created by this bundle that can be connected to other bundles.

View

Properties

internal (object): An arbitrary API. Cannot contain additional properties.
- data (object)
  - api (object)
    - hostname (string): Service host name. If a second host name is needed for internal vs external access, a second artifact is recommended.
    - port (integer): Port number. Minimum: 0. Maximum: 65535.
    - protocol (string): API protocol.
  - etc (object): This field can be used to store arbitrary data to pass to downstream services. Can contain additional properties.
- specs (object): Cannot contain additional properties.
  - api (object): API specifications.
    - version (string): API Version.
  - aws (object): .
    - region (string): AWS Region to provision in.
      
      Examples:
      "us-west-2"
  - azure (object): .
    - region (string): Select the Azure region you'd like to provision your resources in.
  - gcp (object): .
    - project (string)
    - region (string): The GCP region to provision resources in.
      
      Examples:
      "us-east1"
      "us-east4"
      "us-west1"
      "us-west2"
      "us-west3"
      "us-west4"
      "us-central1"

Contributing

Bug Reports & Feature Requests

Did we miss something? Please submit an issue to report any bugs or request additional features.

Developing

Note: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the Massdriver platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.

Still want to get involved? First check out our contribution guidelines.

Fix or Fork

If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or create your own bundle from scratch!

Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!

Name		Name	Last commit message	Last commit date
Latest commit History 44 Commits
.github/workflows		.github/workflows
src		src
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
LICENSE		LICENSE
README.md		README.md
massdriver.yaml		massdriver.yaml
operator.md		operator.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

k8s-unleash

Design