Skip to content

Latest commit

 

History

History
154 lines (117 loc) · 6.25 KB

README.md

File metadata and controls

154 lines (117 loc) · 6.25 KB
Raw

Quortex

kubestatic

An operator to manage the lifecycle of public cloud providers resources needed to expose endpoints on public nodes.

The standard use case for this tool is to provision external IPs on public nodes as well as firewall rules allowing to determine access permissions on these nodes.

Prerequisites

Kubernetes

A Kubernetes cluster of version v1.11.3+ is required. If you are just starting out with Kubestatic, it is highly recommended to use the latest version.

AWS

To be used with AWS and interact with EC2 resources, an AWS account with the following permissions is required:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllObjectActions",
      "Effect": "Allow",
      "Action": [
        "ec2:DescribeSecurityGroups",
        "ec2:CreateSecurityGroup",
        "ec2:DeleteSecurityGroup",
        "ec2:AuthorizeSecurityGroupIngress",
        "ec2:RevokeSecurityGroupIngress",
        "ec2:AuthorizeSecurityGroupEgress",
        "ec2:RevokeSecurityGroupEgress",
        "ec2:DescribeAddresses",
        "ec2:AllocateAddress",
        "ec2:ReleaseAddress",
        "ec2:AssociateAddress",
        "ec2:DisassociateAddress",
        "ec2:DescribeInstances",
        "ec2:ModifyInstanceAttribute",
        "ec2:DescribeNetworkInterfaces",
        "ec2:ModifyNetworkInterfaceAttribute",
        "ec2:CreateTags"
      ],
      "Resource": "*"
    }
  ]
}

Installation

Helm

Follow Kubestatic documentation for Helm deployment here.

Usage

You can create resources via the CRDs documented below or by automatically assign external IPs to your nodes.

CustomResourceDefinitions

Kubestatic acts on the following custom resource definitions (CRDs):

ExternalIP An External IP will allow you to provision and attach an external IP to a node (only AWS ElasticIP supported at the moment). ⚠️ The nodes must be deployed on a public subnet.

FirewallRule A FirewallRule will allow you to configure inbound / outbound firewall rules and attach them to your nodes (only AWS EC2 Security Groups supported at the moment).

You can find examples of CRDs defined by Kubestatic here.

Full API documentation is available here.

ExternalIP auto assign

If you want to automatically attach an external IP to certain nodes of your cluster, simply add the following label to the nodes concerned kubestatic.quortex.io/externalip-auto-assign: true, Kubestatic will deploy an ExternalIP automatically for each of these nodes. If a reserved external IP already exists, Kubestatic will reuse the one associated with the highest number of pods, based on the label kubestatic.quortex.io/externalip.

Here is a sequence diagram describing how it works:

sequenceDiagram
    K8S -->>+ NodeController: See new Node "foo" with externalip-auto-assign label
    NodeController ->>+ K8S: List unused ExternalIP
    K8S ->>- NodeController: [...]
    alt If there is unused ExternalIPs
        NodeController ->>+ K8S: List pods with ExternalIP label
        K8S ->>- NodeController: [...]
        NodeController ->> NodeController : Select the most used ExternalIP
        NodeController ->>+ K8S: Update ExternalIP "bar" to configure it with node "foo"
        K8S ->>- NodeController: OK
    else
        NodeController ->>+ K8S: Create ExternalIP "bar" configured with node "foo"
        K8S ->>- NodeController: OK
    end
    deactivate NodeController

    K8S -->>+ ExternalIPController: See new ExternalIP "bar" for node "foo"
    ExternalIPController ->>+ K8S: Set finalizer
    K8S ->>- ExternalIPController : OK
    ExternalIPController ->>+ AWS: Create address
    AWS ->>- ExternalIPController: OK
    ExternalIPController ->>+ K8S: Update ExternalIP status as reserved
    K8S ->>- ExternalIPController : OK
    deactivate ExternalIPController

    K8S -->>+ ExternalIPController: See reserved ExternalIP "bar" for node "foo"
    ExternalIPController ->>+ K8S: Get Node
    K8S ->>- ExternalIPController : OK
    ExternalIPController ->>+ AWS : Get instance
    AWS ->>- ExternalIPController : OK
    ExternalIPController ->> ExternalIPController: Check that there is a public network interface
    ExternalIPController ->>+ AWS : Associate address to instance
    AWS ->>- ExternalIPController : OK
    ExternalIPController ->>+ K8S: Update ExternalIP status as associated
    K8S ->>- ExternalIPController : OK
    deactivate ExternalIPController

    K8S -->>+ ExternalIPController: See associated ExternalIP "bar" for node "foo"
    ExternalIPController ->>+ K8S: Get Node
    K8S ->>- ExternalIPController : OK
    ExternalIPController ->> ExternalIPController : Check that Node is not being deleted
    ExternalIPController ->>+ K8S: Patch the Node with externalIP label.
    K8S ->>- ExternalIPController : OK
    deactivate ExternalIPController
Loading

Configuration

Optional args

The kubestatic container takes as argument the parameters below.

Key Description Default
cloud-provider Which cloud provider to deploy to. Available values: aws ""
metrics-bind-address The address the metric endpoint binds to. :8080
health-probe-bind-address The address the probe endpoint binds to. :8081
leader-elect Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. false
prevent-eip-deallocation Prevent EIP deallocation on nodes auto-assigned ExternalIPs. false
node-min-reconciliation-interval The minimum duration to wait between two reconciliations for the same node. 10s
node-reconciliation-requeue-interval The duration for which nodes are automatically reconciled. 1m

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Versioning

We use SemVer for versioning.

Help

Got a question? File a GitHub issue.