diff --git a/frontend/src/components/ConnectionDocs/docs/aws.tsx b/frontend/src/components/ConnectionDocs/docs/aws.tsx
index 5184aeb1..3462f683 100644
--- a/frontend/src/components/ConnectionDocs/docs/aws.tsx
+++ b/frontend/src/components/ConnectionDocs/docs/aws.tsx
@@ -7,7 +7,9 @@ import {
Button,
HStack,
Badge,
+ Link,
} from "@chakra-ui/react"
+import { ExternalLinkIcon } from "@chakra-ui/icons"
import { CgArrowRight } from "@react-icons/all-files/cg/CgArrowRight"
import { ListNumber } from "components/utils/ListNumber"
import { useEffect, useState } from "react"
@@ -17,6 +19,31 @@ import {
getAWSDeployAmiURL,
} from "~/constants"
+const KeyStep = ({ num }: { num: number }) => (
+
+
+ To set up mirroring we need an API Key with the following permissions:
+
+ - AmazonEC2FullAccess
+ - AmazonVPCFullAccess
+
+ You can use the{" "}
+
+ aws configure
+ {" "}
+ command or{" "}
+
+ Environment Variables
+
+ {" "}
+ to configure AWS.
+
+
+)
const LOCAL_DOMAINS = ["localhost", "127.0.0.1", "", "::1"]
const AWSDocs = () => {
@@ -65,14 +92,10 @@ const AWSDocs = () => {
{manual ? (
<>
-
-
- Open Port 8081 on your Metlo instance to TCP Connections so
- you can start collecting traffic data. It should be open to
- any machines you want to collect traffic from.
-
-
-
+
Deploy Metlo:
-
-
- To set up mirroring we need an API Key with the following
- permissions:
-
- - AmazonEC2FullAccess
- - AmazonVPCFullAccess
-
-
+
+
You can install metlo from npm by running the following:
@@ -148,7 +164,7 @@ const AWSDocs = () => {
$ npm i -g @metlo/cli
-
+
To set up traffic mirroring run the following:
@@ -211,7 +227,8 @@ const AWSDocs = () => {
-
+
+
Once the instance is created, you can start traffic mirroring
using Metlo's CLI Tool. You can install metlo from npm by
@@ -221,7 +238,7 @@ const AWSDocs = () => {
$ npm i -g @metlo/cli
-
+
To set up traffic mirroring run the following:
diff --git a/frontend/src/components/ConnectionDocs/docs/gcp.tsx b/frontend/src/components/ConnectionDocs/docs/gcp.tsx
index a950c263..c1b9dc52 100644
--- a/frontend/src/components/ConnectionDocs/docs/gcp.tsx
+++ b/frontend/src/components/ConnectionDocs/docs/gcp.tsx
@@ -43,10 +43,10 @@ const GCPDocs = () => {
✔ Obtained router details
✔ Mirror Instance Type · e2-standard-2
- ✔ Metlo URL · {"<"}METLO_URL_HERE{">"}
+ ✔ Metlo URL · http://{"<"}YOUR_METLO_HOST{">"}:8081
- ✔ Metlo API Key · {"<"}METLO_API_KEY_HERE{">"}
+ ✔ Metlo API Key · {"<"}YOUR_METLO_API_KEY{">"}
✔ Created MIG for metlo
✔ Created health check
diff --git a/frontend/src/components/ConnectionDocs/docs/java.tsx b/frontend/src/components/ConnectionDocs/docs/java.tsx
index 88d70ad7..d286e8d8 100644
--- a/frontend/src/components/ConnectionDocs/docs/java.tsx
+++ b/frontend/src/components/ConnectionDocs/docs/java.tsx
@@ -119,7 +119,7 @@ const JavaDocs = () => {
here registrationBean.setFilter(new
- Metlo("http://<YOUR_METLO_ADDRESS>:8081","<YOUR_METLO_API_KEY>");
+ Metlo("http://<YOUR_METLO_HOST>:8081","<YOUR_METLO_API_KEY>");
registrationBean.setOrder(2); return registrationBean;
diff --git a/frontend/src/components/ConnectionDocs/docs/kubernetes.tsx b/frontend/src/components/ConnectionDocs/docs/kubernetes.tsx
index 4509437c..18eed11d 100644
--- a/frontend/src/components/ConnectionDocs/docs/kubernetes.tsx
+++ b/frontend/src/components/ConnectionDocs/docs/kubernetes.tsx
@@ -3,20 +3,6 @@ import { Link, Box, Heading, VStack } from "@chakra-ui/react"
const KubernetesDocs = () => {
return (
-
-
- An API key can be generated by going to the
-
- settings tab
-
- in the nav menu, going to the API Keys section and pressing
- `New` to generate a new API Key
-
-
- After you generate an API Key you can set up Metlo as either a
- daemonset or a sidecar.
-
-
Daemonset
diff --git a/frontend/src/components/ConnectionDocs/docs/node.tsx b/frontend/src/components/ConnectionDocs/docs/node.tsx
index 2907f654..eeb9e742 100644
--- a/frontend/src/components/ConnectionDocs/docs/node.tsx
+++ b/frontend/src/components/ConnectionDocs/docs/node.tsx
@@ -42,8 +42,8 @@ const NodeDocs = () => {
var metlo = require("metlo")
- metlo({"<"}YOUR_METLO_API_KEY{">, <"}
- YOUR_METLO_COLLECTOR_URL{">"})
+ metlo({"<"}YOUR_METLO_API_KEY{">, http://<"}
+ YOUR_METLO_HOST{">:8081"})
diff --git a/frontend/src/components/ConnectionDocs/docs/python.tsx b/frontend/src/components/ConnectionDocs/docs/python.tsx
index b179645f..4f4693b5 100644
--- a/frontend/src/components/ConnectionDocs/docs/python.tsx
+++ b/frontend/src/components/ConnectionDocs/docs/python.tsx
@@ -51,11 +51,11 @@ const PythonDocs = () => {
METLO_CONFIG = {"{"}
"API_KEY":
- {""},
+ {" "},
"METLO_HOST":
- {""}
+ {" \"http://:8081\""}
{"}"}
@@ -77,7 +77,7 @@ const PythonDocs = () => {
from metlo.flask import MetloFlask
app = Flask(__name__)
- MetloFlask(app, {'"<'}YOUR_METLO_COLLECTOR_URL{'>", "<'}
+ MetloFlask(app, {'"http://<'}YOUR_METLO_HOST{'>:8081", "<'}
YOUR_METLO_API_KEY{'>"'})
@@ -89,7 +89,7 @@ const PythonDocs = () => {
communicating with METLO.
- MetloFlask(app, {'"<'}YOUR_METLO_COLLECTOR_URL{'>", "<'}
+ MetloFlask(app, {'"http://<'}YOUR_METLO_HOST{'>:8081", "<'}
YOUR_METLO_API_KEY{'>",'} workers={'"<'}WORKER-COUNT{'>"'})
diff --git a/frontend/src/components/ConnectionDocs/index.tsx b/frontend/src/components/ConnectionDocs/index.tsx
index e476e6e3..7a8fbbeb 100644
--- a/frontend/src/components/ConnectionDocs/index.tsx
+++ b/frontend/src/components/ConnectionDocs/index.tsx
@@ -1,9 +1,8 @@
-import React, { useState } from "react"
+import React from "react"
import {
Box,
VStack,
HStack,
- useDisclosure,
Image,
useColorMode,
TabPanel,
@@ -13,10 +12,8 @@ import {
TabPanels,
Icon,
} from "@chakra-ui/react"
-import { useRouter } from "next/router"
import { ConnectionType } from "@common/enums"
import AWSdocs from "./docs/aws"
-import RenderDocModal from "./renderDocModal"
import GCPDocs from "./docs/gcp"
import { FaJava } from "@react-icons/all-files/fa/FaJava"
import PythonDocs from "./docs/python"
@@ -36,17 +33,7 @@ enum docType {
}
const ConnectionDocsList: React.FC = React.memo(() => {
- const { isOpen, onOpen, onClose } = useDisclosure()
- const router = useRouter()
const colorMode = useColorMode()
- const [displayComponentType, setDisplayComponentType] = useState(
- docType.none,
- )
-
- const openWithComponent = (componentType: docType) => {
- setDisplayComponentType(componentType)
- onOpen()
- }
return (
@@ -149,25 +136,6 @@ const ConnectionDocsList: React.FC = React.memo(() => {
-
-
- > {
- if (displayComponentType == docType.aws) {
- return AWSdocs()
- } else if (displayComponentType == docType.gcp) {
- return GCPDocs()
- } else {
- return <>{displayComponentType}>
- }
- }}
- />
-
)
})
diff --git a/frontend/src/pages/connections/index.tsx b/frontend/src/pages/connections/index.tsx
index 8475284f..8f2b4317 100644
--- a/frontend/src/pages/connections/index.tsx
+++ b/frontend/src/pages/connections/index.tsx
@@ -1,4 +1,4 @@
-import { Heading, VStack } from "@chakra-ui/react"
+import { Heading, Text, VStack, Link } from "@chakra-ui/react"
import { SideNavLinkDestination } from "components/Sidebar/NavLinkUtils"
import { SidebarLayoutShell } from "components/SidebarLayoutShell"
import { ContentContainer } from "components/utils/ContentContainer"
@@ -10,11 +10,15 @@ const Connections = () => {
title="Connections"
currentTab={SideNavLinkDestination.Connections}
>
-
+
-
+
Connections
+
+ Set up a Connection to send API traffic to Metlo. You can generate
+ an API Key on the settings page.
+