edge-defs.json

{
    "categories": [
        {
            "name": "incoming",
            "mapping": "edge",
            "clients": [
                "UICLNT", 
                "MSCLNT", 
                "VHOST",
                "HBCLNT", 
                "JMX",
                "IFCLNT", 
                "GFCLNT" 
            ]
        },
        {
            "name": "outgoing",
            "mapping": "edge",
            "clients": [
                "SMTP",
                "TE"
            ]
        },
        {
            "name": "internal",
            "mapping": "edge",
            "clients": [
                "R", 
                "MP", 
                "MS", 
                "UI", 
                "QS", 
                "PS",
                "PG", 
                "PGs", 
                "PGm", 
                "ZK", 
                "CS",
                "BS",
                "BP",
                "DP"
            ]
        },
        {
            "name": "monitoring",
            "mapping": "edge",
            "clients": [
                "TG", 
                "IF", 
                "GF"
            ]
        },
        {
            "name": "multi-dc",
            "mapping": "multidc",
            "clients": [
                "R",
                "MP",
                "MS",
                "CS",
                "ZK",
                "OL",
                "QS",
                "PS",
                "PGm",
                "PGs"
            ]
        }
    ],
    "mappings": {
        "edge": [
            {
                "client": {
                    "component": "R",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MP",
                            "ports": [
                                "4528",
                                "8998",
                                "8082",
                                "4527"
                            ]
                        },
                        {
                            "component": "MS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        },
                        {
                            "component": "QD",
                            "ports": [
                                "5672"
                            ]
                        },
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160"
                            ]
                        },
                        {
                            "component": "R",
                            "ports": [
                                "4527"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "MS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "4526"
                            ]
                        },
                        {
                            "component": "MP",
                            "ports": [
                                "4528",
                                "8082"
                            ]
                        },
                        {
                            "component": "QS",
                            "ports": [
                                "4529",
                                "8083"
                            ]
                        },
                        {
                            "component": "PS",
                            "ports": [
                                "4530",
                                "8084"
                            ]
                        },
                        {
                            "component": "PG",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGm",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGs",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160",
                                "7199"
                            ]
                        },
                        {
                            "component": "R",
                            "ports": [
                                "4527",
                                "8081"
                            ]
                        },
                        {
                            "component": "OL",
                            "ports": [
                                "10389"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "MP",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        },
                        {
                            "component": "MP",
                            "ports": [
                                "4528"
                            ]
                        },
                        {
                            "component": "QD",
                            "ports": [
                                "5672"
                            ]
                        },
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160"
                            ]
                        },
                        {
                            "component": "TE",
                            "ports": [
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "UI",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        },
                        {
                            "component": "SMTP",
                            "ports": [
                                "25"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "QS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        },
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160"
                            ]
                        },
                        {
                            "component": "PG",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGm",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGs",
                            "ports": [
                                "5432"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "PS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "PG",
                            "ports": [
                                "5432"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "PG",
                    "apigee": false,
                    "servers": [
                    ]
                }
            },
            {
                "client": {
                    "component": "PGm",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "PGs",
                            "ports": [
                                "22"
                            ]
                        },
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "PGs",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "PGm",
                            "ports": [
                                "22"
                            ]
                        },
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "ZK",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "ZK",
                            "ports": [
                                "2888",
                                "3888"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "CS",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "ZK",
                            "ports": [
                                "2181"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "7000",
                                "9042",
                                "9160"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "DP",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MY",
                            "ports": [
                                "3306"
                            ]
                        },
                        {
                            "component": "PG",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "MS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        },
                        {
                            "component": "R",
                            "ports": [
                                "59002"
                            ]
                        },
                        {
                            "component": "SMTP",
                            "ports": [
                                "25"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "OL",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "OL",
                            "ports": [
                                "10389"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "BP",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "BS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "BS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "BS",
                            "ports": [
                                "2551"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "9042",
                                "9160"
                            ]
                        },
                        {
                            "component": "ES",
                            "ports": [
                                "9200-9400"
                            ]
                        },
                        {
                            "component": "SMTP",
                            "ports": [
                                "25"
                            ]
                        }

                    ]
                }
            },


            {
                "client": {
                    "component": "TG",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "IF",
                            "ports": [
                                "8086"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "GF",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "IF",
                            "ports": [
                                "8086"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "IF",
                    "source": "0.0.0.0/0",
                    "servers": [
                    ]
                }
            },


            {
                "client": {
                    "component": "UICLNT",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "UI",
                            "ports": [
                                "9000",
                                "9443"
                            ]
                        },
                        {
                            "component": "BS",
                            "ports": [
                                "9000",
                                "9443"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "MSCLNT",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "UI",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        },
                        {
                            "component": "BS",
                            "ports": [
                                "8080",
                                "8443"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "VHOST",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "R",
                            "ports": [
                                "9000-9200"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "HBCLNT",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "R",
                            "ports": [
                                "15999"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "JMX",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "1099"
                            ]
                        },
                        {
                            "component": "MP",
                            "ports": [
                                "1101"
                            ]
                        },
                        {
                            "component": "QS",
                            "ports": [
                                "1102"
                            ]
                        },
                        {
                            "component": "PS",
                            "ports": [
                                "1103"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "7199"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "IFCLNT",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "IF",
                            "ports": [
                                "8183"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "GFCLNT",
                    "source": "0.0.0.0/0",
                    "servers": [
                        {
                            "component": "GF",
                            "ports": [
                                "3000"
                            ]
                        }
                    ]
                }
            },


            {
                "client": {
                    "component": "SMTP",
                    "source": "0.0.0.0/0",
                    "servers": [
                    ]
                }
            },
            {
                "client": {
                    "component": "TE",
                    "source": "0.0.0.0/0",
                    "servers": [
                    ]
                }
            }
        ], 
        "multidc": [
            {
                "client": {
                    "component": "R",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "8080"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "MP",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MP",
                            "ports": [
                                "4528"
                            ]
                        },
                        {
                            "component": "MS",
                            "ports": [
                                "8080"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "MS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "R",
                            "ports": [
                                "1100",
                                "4527",
                                "8081"
                            ]
                        },
                        {
                            "component": "MP",
                            "ports": [
                                "1101",
                                "4528",
                                "8082"
                            ]
                        },
                        {
                            "component": "CS",
                            "ports": [
                                "7000",
                                "9042",
                                "9160",
                                "7199"
                            ]
                        },
                        {
                            "component": "PG",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGm",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGs",
                            "ports": [
                                "5432"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "ZK",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "ZK",
                            "ports": [
                                "2181",
                                "2888",
                                "3888"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "CS",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "CS",
                            "ports": [
                                "7000",
                                "7199",
                                "9042",
                                "9160"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "OL",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "OL",
                            "ports": [
                                "10389"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "QS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "8080"
                            ]
                        },
                        {
                            "component": "PG",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGm",
                            "ports": [
                                "5432"
                            ]
                        },
                        {
                            "component": "PGs",
                            "ports": [
                                "5432"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "PS",
                    "apigee": true,
                    "servers": [
                        {
                            "component": "MS",
                            "ports": [
                                "8080"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "PGm",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "PGm",
                            "ports": [
                                "22",
                                "5432"
                            ]
                        },
                        {
                            "component": "PGs",
                            "ports": [
                                "22",
                                "5432"
                            ]
                        }
                    ]
                }
            },
            {
                "client": {
                    "component": "PGs",
                    "apigee": false,
                    "servers": [
                        {
                            "component": "PGm",
                            "ports": [
                                "22",
                                "5432"
                            ]
                        },
                        {
                            "component": "PGs",
                            "ports": [
                                "22",
                                "5432"
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "ports": [
        { "id": "25", "type": "rmi", "description": "Defalt SMTP Server port" },

        { "id": "1099", "type": "tcp,jmx rmi", "description": "JMX Management" },
        { "id": "1100", "type": "tcp,jmx rmi", "description": "JMX Management" },
        { "id": "1101", "type": "tcp,jmx rmi", "description": "JMX Management" },
        { "id": "1102", "type": "tcp,jmx rmi", "description": "JMX Management" },
        { "id": "1103", "type": "tcp,jmx rmi", "description": "JMX Management" },
        { "id": "2181", "type": "tcp,zab", "description": "Zookeeper clients to connect to zk servers" },
        { "id": "2888", "type": "tcp", "description": "Zookeeper internode management: zk peers sending transaction updates" },
        { "id": "3888", "type": "tcp", "description": "Zookeeper internode management: for leader election (electionAlg=3,default)" },

        { "id": "3306", "type": "tcp/udp", "description": "DEVPortal to MariaDB/MySQL" },

        { "id": "4526", "type": "rpc", "description": "Distributed cache and calls from the Management Servers to the Management Server" },
        { "id": "4527", "type": "rpc", "description": "Distributed cache and calls from the Management Servers to the Router" },
        { "id": "4528", "type": "rpc", "description": "Distributed cache calls between Message Processors, and for communication from the Router" },
        { "id": "4529", "type": "rpc", "description": "Distributed cache and calls from the Management Servers to the Qpid Server" },
        { "id": "4530", "type": "rpc", "description": "Distributed cache and calls from the Management Servers to the Postgres Server" },

        { "id": "5432", "type": "tcp", "description": "PostgreSQL message-based protocol for communication between frontends and backends (clients and servers)" },
        { "id": "5672", "type": "tcp,amqp", "description": "Sending analytics from Router and Message Processor to Qpid" },

        { "id": "7000", "type": "tcp", "description": "Cassandra inter-node communications (gossip/replication/proxied queries/etc)" },

        { "id": "7199", "type": "tcp,jmx rmi", "description": "Cassandra JMX management. Must be open for access on the Cassandra node by the Management Server." },

        { "id": "8080", "type": "http", "description": "Default Management API Calls" },
        { "id": "8443", "type": "http", "description": "Default Management API Calls via TLS" },

        { "id": "8081", "type": "http", "description": "Issuing API requests directly to Router" },
        { "id": "8082", "type": "http", "description": "Issuing API requests directly to Message Processor" },
        { "id": "8083", "type": "http", "description": "Issuing API requests directly to Qpid Server" },
        { "id": "8084", "type": "http", "description": "Issuing API requests directly to Postgres Server" },

        { "id": "8086", "type": "http", "description": "Telegraph to Influx DB" },
        { "id": "8183", "type": "http", "description": "Browser to InfluxDB" },
        { "id": "3000", "type": "http", "description": "Browser to Graphana" },

        { "id": "8998", "type": "http", "description": "Communication between Router and Message Processor" },
        { "id": "9000", "type": "http", "description": "Default Edge management UI port" },
        { "id": "9443", "type": "http", "description": "Default Edge management UI port via TLS" },

        { "id": "9042", "type": "tcp", "description": "Cassandra CQL native transport" },

        { "id": "9160", "type": "tcp,thrift rpc", "description": "Cassandra thrift client" },

        { "id": "10389", "type": "tcp,ldap", "description": "OpenLDAP port" },

        { "id": "15999", "type": "tcp", "description": "Health check port for a load balancer" },


        { "id": "59001", "type": "http", "description": "Port used by the apigee-validate utility to test the Edge installation" },
        { "id": "59002", "type": "http", "description": "The router port where SmartDocs page requests are sent" }
    ],
    "externalclientspseudosubnets": [
        {
            "name": "clients",
            "nodes": [
                {
                    "id": -1,
                    "hostname": "client",
                    "ip": "0.0.0.0/0",
                    "components": [
                        "UICLNT", 
                        "MSCLNT", 
                        "VHOST",
                        "HBCLNT", 
                        "JMX",
                        "IFCLNT", 
                        "GFCLNT"
                    ]
                }
            ]
        },
        {
            "name": "servers",
            "nodes": [
                {
                    "id": -2,
                    "hostname": "server",
                    "ip": "0.0.0.0/0",
                    "components": [
                        "SMTP",
                        "TE" 
                    ]
                }
            ]
        }
    ],
    "lbhealthchecks" : {
        "MS": {
            "pingProtocol": "jmx",
            "pingPort": "1101",
            "pingPath": "",
            "responsecode": 200
        },
        "R": {
            "pingProtocol": "http",
            "pingPort": 15999,
            "pingPath": "http://$host:8081/v1/servers/self/up",
            "responsecode": 200
        }
     },
    "edgecomponentinstallsequence": [ 
        "DS", "ZK", "CS", "OLMSUI", "OL", "MS", "UI", "SAX", "QS", "PS", "RMP", "R", "MP", "ES", "BS", "BP", "DP", "IF", "TG", "GF"
    ],
    "edgecomponentstartsequence": [ 
        "IF", "TG", "GF", "ZK", "CS", "OL", "PGm", "PGs", "PG", "PS", "QD", "QS", "MS", "MP", "R", "UI", "ES", "BS", "BP"
    ],
    "edgecomponentstopsequence": [ 
        "BP", "BS", "ES", "UI", "R", "MP", "MS", "QS", "QD", "PS", "PG", "PGs", "PGm", "OL", "CS", "ZK", "GF", "TG", "IF"
    ],

    "customer": {
        "bindOnAllInterfaces": "y",
        "enableSystemCheck": "y",
        "adminEmail": "admin@apigee.com",
        "adminPassword": "Apigee123!",
        "licenseFile": "/opt/apigee-install/configs/license.txt",
        "mpPod": "gateway",
        "region": "dc-1",
        "cassAuth": "y",
        "cassUsername": "cassandra",
        "cassPassword": "cassandra",
        "cassClustername": "Apigee",
        "pgUsername": "apigee",
        "pgPassword": "postgres",
        "skipSmtp": "y",
        "smtpHost": "192.168.56.1",
        "smtpPort": "25",
        "smtpSsl": "n"
    }
}