{"id":13765556,"url":"https://github.com/nginxinc/nginmesh","last_synced_at":"2025-05-10T21:31:08.461Z","repository":{"id":68950229,"uuid":"101824999","full_name":"nginxinc/nginmesh","owner":"nginxinc","description":"Istio compatible service mesh using NGINX","archived":true,"fork":false,"pushed_at":"2018-11-12T11:34:39.000Z","size":30429,"stargazers_count":607,"open_issues_count":5,"forks_count":76,"subscribers_count":85,"default_branch":"master","last_synced_at":"2024-11-17T01:32:52.853Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nginxinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-08-30T01:46:38.000Z","updated_at":"2024-08-03T23:44:08.000Z","dependencies_parsed_at":"2023-07-14T02:22:14.196Z","dependency_job_id":null,"html_url":"https://github.com/nginxinc/nginmesh","commit_stats":null,"previous_names":["nginmesh/nginmesh"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginmesh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginmesh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginmesh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginmesh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nginxinc","download_url":"https://codeload.github.com/nginxinc/nginmesh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253484971,"owners_count":21915928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T16:00:41.179Z","updated_at":"2025-05-10T21:31:07.916Z","avatar_url":"https://github.com/nginxinc.png","language":"Go","funding_links":[],"categories":["Frameworks / Runtimes","Service Mesh"],"sub_categories":[],"readme":"# Important Project Notice\nThis project is no longer under active development. It will be preserved here for the foreseeable future for reference. Please note that the last version released works with Istio 0.7. \n\n# NGINX Architecture with Istio Service Mesh\nThis repository provides an implementation of a NGINX based service mesh (nginMesh).  nginMesh is compatible with Istio.  It leverages NGINX as a sidecar proxy. \n\n## What is Service Mesh and Istio?\nPlease check https://istio.io for a detailed explanation of the service mesh.  \n\n## Production Status\nThe current version of nginMesh is designed to work with Istio release 0.7.1. It should not be used in production environments.  \n\n## Demo\n[Recorded demo](https://www.nginx.com/resources/webinars/istio-the-extensible-service-mesh/) of nginMesh depoyment.\n\n## Architecture\nThe diagram below depicts how an NGINX sidecar proxy is implemented. The sidecar uses the open source version of NGINX compiled with modules for tracing and monitoring.\n\n![Alt text](/images/nginx_sidecar.png?raw=true \"NGINX Sidecar\")\n\nThe diagram below is an alternative architectural view - \n\n![Alt text](/images/nginMesh%20architecture%20-%20Lee%20Calcote.png?raw=true \"nginMesh Diagram\")\n\nTo learn more about the sidecar implementation, see [this document](istio/agent).\n\n## Quick Start\nBelow are instructions to quickly install and configure nginMesh.  Currently, only Kubernetes environment is supported.\n\n### Prerequisites\nMake sure you have a cluster with Kubernetes 1.9 or newer. Please see [Prerequisites](https://archive.istio.io/v0.7/docs/setup/kubernetes/quick-start.html#prerequisites) for setting up a kubernetes cluster.\n\n### Install Istio and nginMesh\nnginMesh requires installation of Istio first.\n\n1. Download and install Istio 0.7.1:\n    ```\n    curl -L https://git.io/getLatestIstio | ISTIO_VERSION=0.7.1 sh -\n    ```\n2. Download nginMesh release 0.7.1:\n    ```\n    curl -L https://github.com/nginxinc/nginmesh/releases/download/v0.7.1/nginmesh-0.7.1.tar.gz | tar zx\n    ```\n3. Deploy Istio:\n    ```\n    kubectl create -f istio-0.7.1/install/kubernetes/istio.yaml\n    ```\n4. Ensure the following Kubernetes services are deployed: istio-pilot, istio-mixer, istio-ingress:\n    ```\n    kubectl get svc  -n istio-system  \n    ```\n    ```\n    istio-ingress            LoadBalancer   10.47.252.40    35.237.173.47   80:32171/TCP,443:32198/TCP                   19h\n    istio-mixer              ClusterIP      10.47.251.225   \u003cnone\u003e          9091/TCP,15004/TCP,9093/TCP,9094/TCP,9102/TCP,9125/UDP,42422/TCP    19h\n    istio-pilot              ClusterIP      10.47.254.118   \u003cnone\u003e          15003/TCP,15005/TCP,15007/TCP,15010/TCP,8080/TCP,9093/TCP,443/TCP   19h\n    istio-sidecar-injector   ClusterIP      10.47.242.139   \u003cnone\u003e          443/TCP                                       9h\n    ```\n5. Ensure the following Kubernetes pods are up and running: istio-pilot-* , istio-mixer-* , istio-ingress-*  and istio-initializer-*:\n    ```\n    kubectl get pods -n istio-system    \n    ```\n    ```\n    istio-ca-86f55cc46f-nprhw                1/1       Running   0          19h\n    istio-ingress-5bb556fcbf-c7tgt           1/1       Running   0          19h\n    istio-mixer-86f5df6997-fvzjx             3/3       Running   0          19h\n    istio-pilot-67d6ddbdf6-xhztz             2/2       Running   0          19h\n    istio-sidecar-injector-5b8c78fd6-8dvq6   1/1       Running   0          9h\n    ```\n6. Enable automatic sidecar injection:\n    ```\n    nginmesh-0.7.1/install/kubernetes/install-sidecar.sh\n    ```\n7.  Verify that the istio-injection label is not applied to the default namespace:\n    ```\n    kubectl get namespace -L istio-injection\n    ```\n    ```\n    NAME           STATUS        AGE       ISTIO-INJECTION\n    default        Active        1h        \n    istio-system   Active        1h        \n    kube-public    Active        1h        \n    kube-system    Active        1h\n    ```\n\n### Deploy a Sample Application\n\nIn this section we deploy the Bookinfo application, which is taken from the Istio samples. Please see [Bookinfo](https://istio.io/docs/guides/bookinfo.html)  for more details.\n\n1. Label the default namespace with istio-injection=enabled:\n    ```\n    kubectl label namespace default istio-injection=enabled\n    ```\n2. Deploy the application:\n    ```\n    kubectl apply -f  istio-0.7.1/samples/bookinfo/kube/bookinfo.yaml\n    ```\n3. Confirm that all application services are deployed: productpage, details, reviews, ratings:\n    ```\n    kubectl get services\n    ```\n    ```\n    NAME                       CLUSTER-IP   EXTERNAL-IP   PORT(S)              AGE\n    details                    10.0.0.31    \u003cnone\u003e        9080/TCP             6m\n    kubernetes                 10.0.0.1     \u003cnone\u003e        443/TCP              7d\n    productpage                10.0.0.120   \u003cnone\u003e        9080/TCP             6m\n    ratings                    10.0.0.15    \u003cnone\u003e        9080/TCP             6m\n    reviews                    10.0.0.170   \u003cnone\u003e        9080/TCP             6m\n    ```\n4. Confirm that all application pods are running --details-v1-* , productpage-v1-* , ratings-v1-* , reviews-v1-* , reviews-v2-* and reviews-v3-*:\n    ```\n    kubectl get pods\n    ```\n    ```\n    NAME                                        READY     STATUS    RESTARTS   AGE\n    details-v1-1520924117-48z17                 2/2       Running   0          6m\n    productpage-v1-560495357-jk1lz              2/2       Running   0          6m\n    ratings-v1-734492171-rnr5l                  2/2       Running   0          6m\n    reviews-v1-874083890-f0qf0                  2/2       Running   0          6m\n    reviews-v2-1343845940-b34q5                 2/2       Running   0          6m\n    reviews-v3-1813607990-8ch52                 2/2       Running   0          6m\n    ```\n5. Get the public IP of the Istio Ingress controller. If the cluster is running in an environment that supports external load balancers:\n    ```\n    kubectl get svc -n istio-system | grep -E 'EXTERNAL-IP|istio-ingress'\n    ```\n6. Open the Bookinfo application in a browser using the following link:\n    ```\n    http://\u003cPublic-IP-of-the-Ingress-Controller\u003e/productpage\n    ```\n\n\n### Uninstall the Application\n\n1. To uninstall application, run:\n    ```\n    ./istio-0.7.1/samples/bookinfo/kube/cleanup.sh\n    ```\n\n### Uninstall Istio\n\n1. To uninstall the Istio core components:\n    ```\n    kubectl delete -f istio-0.7.1/install/kubernetes/istio.yaml\n    ```\n2. To uninstall the initializer, run:\n    ```\n    nginmesh-0.7.1/install/kubernetes/delete-sidecar.sh\n    ```\n\n## Limitations\nnginMesh has the following limitations:\n* TCP and gRPC traffic is not supported.\n* Quota Check is not supported.\n* Only Kubernetes is supported.\n\nAll sidecar-related limitations and supported traffic management rules are described [here](istio/agent).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginxinc%2Fnginmesh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnginxinc%2Fnginmesh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginxinc%2Fnginmesh/lists"}