Giter Site home page Giter Site logo

smartrus / nginx-ingress-helm-operator Goto Github PK

View Code? Open in Web Editor NEW

This project forked from nginxinc/nginx-ingress-helm-operator

0.0 0.0 0.0 769 KB

NGINX Ingress Operator for NGINX and NGINX Plus Ingress Controllers. Based on the Helm chart for NGINX Ingress Controller - https://github.com/nginxinc/helm-charts

License: Apache License 2.0

Shell 13.91% Makefile 60.05% Dockerfile 12.84% Mustache 13.20%

nginx-ingress-helm-operator's Introduction

Continuous Integration

NGINX Ingress Operator

The NGINX Ingress Operator is a Kubernetes/OpenShift component which deploys and manages one or more NGINX/NGINX Plus Ingress Controllers which in turn handle Ingress traffic for applications running in a cluster.

Learn more about operators in the Kubernetes Documentation.

To install a specific version of the NGINX Ingress Controller with the operator, a specific version of the NGINX Ingress Operator is required.

Up until version 0.5.1, this Operator was Go based. Version 1.0.0 marks an uncompatible upgrade as this release swtiched the Operator to being Helm-based, built from the NGINX Ingress Controller Helm chart. The configuration for the Helm chart can be seen in the NGINX Ingress Controller documentation.

The following table shows the relation between the versions of the two projects:

NGINX Ingress Controller NGINX Ingress Operator
2.2.x 1.0.0
2.1.x 0.5.1
2.0.x 0.4.0
1.12.x 0.3.0
1.11.x 0.2.0
1.10.x 0.1.0
1.9.x 0.0.7
1.8.x 0.0.6
1.7.x 0.0.4
< 1.7.0 N/A

Note: The NGINX Ingress Operator works only for NGINX Ingress Controller versions after 1.7.0.

Getting Started

  1. Install the NGINX Ingress Operator. See docs.
    NOTE: To use TransportServers as part of your NGINX Ingress Controller configuration, a GlobalConfiguration resource must be created before starting the Operator - see the notes
  2. Create a default server secret on the cluster - an example yaml for this can be found in the examples folder
  3. (If using OpenShift) Create the scc resource on the cluster by applying the scc.yaml file found in the resources folder of this repo:
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-operator-helm/v1.0.0/resources/scc.yaml
  1. Deploy a new NGINX Ingress Controller using the NginxIngress Custom Resource:
    • Use the name of the default server secret created above for controller.defaultTLS.secret field (needs to be in the form namespace/name)
    • If using NGINX Plus:
      • Set the controller.nginxPlus to true
      • Set the controller.image.repository and controller.image.tag to the appropriate values
      • Set the controller.serviceAccount.imagePullSecretName if applicable
    • For full configuration details see the Helm documentation here.

Notes: Multiple NIC Deployments

  • Please see the NGINX Ingress Controller doumentation for general information on running multiple NGINX Ingress Controllers in your cluster.
  • To run multiple NIC instances deployed by the NGINX Ingress Operator in your cluster in the same namespace, rbac.create should be set to false, and the ServiceAccount and ClusterRoleBinding need to be created independently of the deployments. Please note that controller.serviceAccount.imagePullSecretName will also be ignored in this configuration, and will need to be configured as part of the independant ServiceAccount creation.
  • The ClusterRoleBinding needs to configured to bind to the nginx-ingress-operator-nginx-ingress-admin ClusterRole.
  • See RBAC example spec for an example ServiceAccount and ClusterRoleBinding manifest.
  • To run multiple NIC instances deployed by the NGINX Ingress Operator in your cluster in any namespace but sharing an IngressClass, controller.ingressClass should be set to an empty string and the IngressClass resource needs to be created independantly of the deployments.Please note that controller.setAsDefaultIngress will also be ignored in this configuration, and will need to be configured as part of the independant IngressClass creation.
  • See IngressClass example spec for an example IngressClass manifest.

Upgrades

See upgrade docs

NGINX Ingress Operator Releases

We publish NGINX Ingress Operator releases on GitHub. See our releases page.

The latest stable release is 1.0.0. For production use, we recommend that you choose the latest stable release.

Development

It is possible to run the operator in your local machine. This is useful for testing or during development.

Run Operator locally

  1. Have access to a Kubernetes/Openshift cluster.
  2. Apply the IC CRD:
     make install
    
  3. Run make run.

The operator will run in your local machine but will be communicating with the cluster.

Contributing

If you'd like to contribute to the project, please read our Contributing guide.

nginx-ingress-helm-operator's People

Contributors

ciarams87 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.