Metadata-Version: 2.1
Name: cdk8s-aws-lb-controller-api-object
Version: 0.0.0
Summary: @opencdk8s/cdk8s-aws-lb-controller-api-object
Home-page: https://github.com/opencdk8s/cdk8s-aws-lb-controller-api-object
Author: Hunter Thompson<aatman@auroville.org.in>
License: Apache-2.0
Project-URL: Source, https://github.com/opencdk8s/cdk8s-aws-lb-controller-api-object
Description: # cdk8s-aws-lb-controller-api-object
        
        ![Release](https://github.com/opencdk8s/cdk8s-aws-lb-controller-api-object/workflows/Release/badge.svg?branch=development)
        [![npm version](https://badge.fury.io/js/%40opencdk8s%2Fcdk8s-aws-lb-controller-api-object.svg)](https://badge.fury.io/js/%40opencdk8s%2Fcdk8s-aws-lb-controller-api-object)
        [![PyPI version](https://badge.fury.io/py/cdk8s-aws-lb-controller-api-object.svg)](https://badge.fury.io/py/cdk8s-aws-lb-controller-api-object)
        ![npm](https://img.shields.io/npm/dt/@opencdk8s/cdk8s-aws-lb-controller-api-object?label=npm&color=green)
        
        API Object for AWS Load Balancer Controller, powered by the [cdk8s project](https://cdk8s.io) and [aws-load-balancer-controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller)  🚀
        
        ## Overview
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        from constructs import Construct
        from cdk8s import App, Chart, ChartProps
        from opencdk8s.cdk8s_aws_lb_controller_api_object import AWSLoadBalancerControllerObject
        
        class MyChart(Chart):
            def __init__(self, scope, id, *, namespace=None, labels=None):
                super().__init__(scope, id, namespace=namespace, labels=labels)
                AWSLoadBalancerControllerObject(self, "example",
                    metadata={
                        "annotations": {
                            "kubernetes.io/ingress.class": "alb"
                        }
                    },
                    spec={
                        "rules": [{
                            "host": "example.com",
                            "http": {
                                "paths": [{
                                    "path": "/*",
                                    "backend": {
                                        "service_name": "helloworld-svc",
                                        "service_port": 80
                                    }
                                }]
                            }
                        }]
                    }
                )
        
        app = App()
        MyChart(app, "example")
        app.synth()
        ```
        
        Example `cdk8s synth` manifest as follows.
        
        <details>
        <summary>manifest.k8s.yaml</summary>
        
        ```yaml
        apiVersion: extensions/v1beta1
        kind: Ingress
        metadata:
          annotations:
            kubernetes.io/ingress.class: alb
          name: example-c89c1904
        spec:
          rules:
            - host: example.com
              http:
                paths:
                  - backend:
                      serviceName: helloworld-svc
                      servicePort: 80
                    path: /*
        
        
        ```
        
        </details>
        
        ## Installation
        
        ### TypeScript
        
        Use `yarn` or `npm` to install.
        
        ```sh
        $ npm install @opencdk8s/cdk8s-aws-lb-controller-api-objects
        ```
        
        ```sh
        $ yarn add @opencdk8s/cdk8s-aws-lb-controller-api-objects
        ```
        
        ### Python
        
        ```sh
        $ pip install cdk8s-aws-lb-controller-api-objects
        ```
        
        ## Contribution
        
        1. Fork ([link](https://github.com/opencdk8s/cdk8s-aws-lb-controller-api-objects/fork))
        2. Bootstrap the repo:
        
           ```bash
           yarn install # installs dependencies
           yarn projen
           ```
        3. Development scripts:
           |Command|Description
           |-|-
           |`yarn compile`|Compiles typescript => javascript
           |`yarn watch`|Watch & compile
           |`yarn test`|Run unit test & linter through jest
           |`yarn test -u`|Update jest snapshots
           |`yarn run package`|Creates a `dist` with packages for all languages.
           |`yarn build`|Compile + test + package
           |`yarn bump`|Bump version (with changelog) based on [conventional commits]
           |`yarn release`|Bump + push to `master`
        4. Create a feature branch
        5. Commit your changes
        6. Rebase your local changes against the master branch
        7. Create a new Pull Request (use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for the title please)
        
        ## Licence
        
        [Apache License, Version 2.0](./LICENSE)
        
        ## Author
        
        [Hunter-Thompson](https://github.com/Hunter-Thompson)
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
