diff --git a/.github/workflows/build-develop.yml b/.github/workflows/build-develop.yml index 50346e059..0b6d7da37 100644 --- a/.github/workflows/build-develop.yml +++ b/.github/workflows/build-develop.yml @@ -320,19 +320,12 @@ jobs: - name: Debug ref tag run: echo ${{ env.REF_TAG }} - - - name: Login to GitHub Container Registry - uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - name: Login to Docker Hub uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 with: - username: ${{ secrets.ORB_DOCKERHUB_USERNAME }} - password: ${{ secrets.ORB_DOCKERHUB_TOKEN }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Replace token run: | @@ -353,27 +346,24 @@ jobs: - name: Build + push - pktvisor (multi-arch) env: - IMAGE_NAME1: orbcommunity/pktvisor - IMAGE_NAME2: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 #v6.10.0 with: builder: ${{ steps.buildx.outputs.name }} context: . file: ./docker/Dockerfile.crashhandler platforms: linux/amd64 - tags: ${{ env.IMAGE_NAME1 }}:${{ needs.unit-tests-linux.outputs.version_number }} , ${{ env.IMAGE_NAME1 }}:${{ env.REF_TAG }} , ${{ env.IMAGE_NAME2 }}:amd64-${{needs.unit-tests-linux.outputs.commit_hash}} + tags: ${{ env.IMAGE_NAME }}:${{ needs.unit-tests-linux.outputs.version_number }} , ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} outputs: type=docker,dest=/tmp/amd64.tar - name: Load image env: - IMAGE_NAME1: orbcommunity/pktvisor - IMAGE_NAME2: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor run: | docker load --input /tmp/amd64.tar docker image ls -a - docker push ${{ env.IMAGE_NAME2 }}:amd64-${{needs.unit-tests-linux.outputs.commit_hash}} - docker push ${{ env.IMAGE_NAME1 }}:${{ env.REF_TAG }} - docker push ${{ env.IMAGE_NAME1 }}:${{ needs.unit-tests-linux.outputs.version_number }} + docker push ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} + docker push ${{ env.IMAGE_NAME }}:${{ needs.unit-tests-linux.outputs.version_number }} build-app-image-x64: needs: [ package-amd64 ] @@ -439,12 +429,12 @@ jobs: - name: Login to Docker Hub uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 with: - username: ${{ secrets.ORB_DOCKERHUB_USERNAME }} - password: ${{ secrets.ORB_DOCKERHUB_TOKEN }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Build + push - pktvisor-prom-write env: - IMAGE_NAME: orbcommunity/pktvisor-prom-write + IMAGE_NAME: netboxlabs/pktvisor-prom-write working-directory: ${{github.workspace}}/centralized_collection/prometheus/docker-grafana-agent run: | docker build . --file Dockerfile --build-arg PKTVISOR_TAG=${{ env.REF_TAG }} --tag ${{ env.IMAGE_NAME }}:${{ env.VERSION }} --tag ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} @@ -452,7 +442,7 @@ jobs: - name: Generate AppImage env: - IMAGE_NAME: orbcommunity/pktvisor + IMAGE_NAME: netboxlabs/pktvisor working-directory: ${{github.workspace}}/appimage run: | DEV_IMAGE="${{ env.IMAGE_NAME }}:${{ env.VERSION }}" DEV_MODE=t make pktvisor-x86_64.AppImage @@ -514,12 +504,11 @@ jobs: echo "PRERELEASE=false" >> $GITHUB_ENV echo "DRAFT=true" >> $GITHUB_ENV - - name: Login to GitHub Container Registry + - name: Login to Docker Hub uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Set up QEMU uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf #v3.2.0 @@ -541,95 +530,21 @@ jobs: - name: Build + push - pktvisor (multi-arch) id: docker_build env: - IMAGE_NAME: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 #v6.10.0 with: builder: ${{ steps.buildx.outputs.name }} context: . file: ./docker/Dockerfile.crashhandler platforms: linux/arm64 - tags: ${{ env.IMAGE_NAME }}:arm64-${{needs.unit-tests-linux.outputs.commit_hash}} + tags: ${{ env.IMAGE_NAME }}:${{ needs.unit-tests-linux.outputs.version_number }} , ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} outputs: type=docker,dest=/tmp/arm64.tar - name: Load image env: - IMAGE_NAME: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor run: | docker load --input /tmp/arm64.tar docker image ls -a - docker push ${{ env.IMAGE_NAME }}:arm64-${{needs.unit-tests-linux.outputs.commit_hash}} - - pushing-manifests: - needs: [ unit-tests-linux, package-amd64, package-arm64 ] - runs-on: ubuntu-latest - if: github.event_name != 'pull_request' - steps: - - name: Login to GitHub Container Registry - uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Create docker manifest - run: | - docker manifest create ghcr.io/orb-community/pktvisor:latest-develop \ - ghcr.io/orb-community/pktvisor:amd64-${{needs.unit-tests-linux.outputs.commit_hash}} \ - ghcr.io/orb-community/pktvisor:arm64-${{needs.unit-tests-linux.outputs.commit_hash}} - - - name: Push manifest to ghcr.io - run: | - docker manifest push ghcr.io/orb-community/pktvisor:latest-develop - - - name: Install skopeo - run: | - sudo apt-get update - sudo apt-get install -y skopeo - - - name: Login skopeo to ghcr - run: | - sudo skopeo login -u ${{ github.repository_owner }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io - - - name: Login skopeo to dockerhub - run: | - sudo skopeo login -u ${{ secrets.DOCKERHUB_USERNAME }} -p ${{ secrets.DOCKERHUB_TOKEN }} docker.io - - - name: Copy from ghcr.io to docker.io - run: | - sudo skopeo copy \ - --all \ - docker://ghcr.io/orb-community/pktvisor:latest-develop \ - docker://docker.io/orbcommunity/pktvisor:latest-develop - sudo skopeo copy \ - --all \ - docker://ghcr.io/orb-community/pktvisor:latest-develop \ - docker://docker.io/orbcommunity/pktvisor:develop - sudo skopeo copy \ - --all \ - docker://ghcr.io/orb-community/pktvisor:latest-develop \ - docker://docker.io/orbcommunity/pktvisor:${{ needs.unit-tests-linux.outputs.version_number }} - - - - name: Delete arm64 images from ghcr.io - uses: bots-house/ghcr-delete-image-action@3827559c68cb4dcdf54d813ea9853be6d468d3a4 #v1.1.0 - with: - owner: orb-community - name: pktvisor - token: ${{ secrets.GITHUB_TOKEN }} - tag: arm64-${{needs.unit-tests-linux.outputs.commit_hash}} - - - name: Delete amd64 images from ghcr.io - uses: bots-house/ghcr-delete-image-action@3827559c68cb4dcdf54d813ea9853be6d468d3a4 #v1.1.0 - with: - owner: orb-community - name: pktvisor - token: ${{ secrets.GITHUB_TOKEN }} - tag: amd64-${{needs.unit-tests-linux.outputs.commit_hash}} - - - name: Delete latest-develop images from ghcr.io - uses: bots-house/ghcr-delete-image-action@3827559c68cb4dcdf54d813ea9853be6d468d3a4 #v1.1.0 - with: - owner: orb-community - name: pktvisor - token: ${{ secrets.GITHUB_TOKEN }} - tag: latest-develop + docker push ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} + docker push ${{ env.IMAGE_NAME }}:${{ needs.unit-tests-linux.outputs.version_number }} diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml index 3e1190467..eb7ab1c16 100644 --- a/.github/workflows/build-release.yml +++ b/.github/workflows/build-release.yml @@ -293,7 +293,7 @@ jobs: shell: bash run: | chmod a+x ./docker/upload-gh-asset.sh - ./docker/upload-gh-asset.sh github_api_token=${{ secrets.BOT_TOKEN }} owner=orb-community repo=pktvisor tag=LATEST filename=./pktvisor-win64.zip + ./docker/upload-gh-asset.sh github_api_token=${{ secrets.BOT_TOKEN }} owner=netboxlabs repo=pktvisor tag=LATEST filename=./pktvisor-win64.zip package-arm64: needs: [ prebuild-package ] @@ -343,7 +343,7 @@ jobs: - name: Upload arm64 binary to latest release run: | chmod a+x ./docker/upload-gh-asset.sh - ./docker/upload-gh-asset.sh github_api_token=${{ secrets.BOT_TOKEN }} owner=orb-community repo=pktvisor tag=LATEST filename=./pktvisor-arm64.zip + ./docker/upload-gh-asset.sh github_api_token=${{ secrets.BOT_TOKEN }} owner=netboxlabs repo=pktvisor tag=LATEST filename=./pktvisor-arm64.zip - name: Get branch name shell: bash @@ -369,12 +369,11 @@ jobs: - name: Debug ref tag run: echo ${{ env.REF_TAG }} - - name: Login to GitHub Container Registry + - name: Login to Docker Hub uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Set up QEMU uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf #v3.2.0 @@ -396,23 +395,24 @@ jobs: - name: Build + push - pktvisor (multi-arch) id: docker_build env: - IMAGE_NAME: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 #v6.10.0 with: builder: ${{ steps.buildx.outputs.name }} context: . file: ./docker/Dockerfile.crashhandler platforms: linux/arm64 - tags: ${{ env.IMAGE_NAME }}:release-arm64 + tags: ${{ env.IMAGE_NAME }}:latest, ${{ env.IMAGE_NAME }}:${{ env.VERSION }} outputs: type=docker,dest=/tmp/arm64.tar - name: Load image env: - IMAGE_NAME: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor run: | docker load --input /tmp/arm64.tar docker image ls -a - docker push ${{ env.IMAGE_NAME }}:release-arm64 + docker push ${{ env.IMAGE_NAME }}:latest + docker push ${{ env.IMAGE_NAME }}:${{ env.VERSION }} package-amd64: @@ -464,7 +464,7 @@ jobs: - name: Upload amd64 binary to latest release run: | chmod a+x ./docker/upload-gh-asset.sh - ./docker/upload-gh-asset.sh github_api_token=${{ secrets.BOT_TOKEN }} owner=orb-community repo=pktvisor tag=LATEST filename=./pktvisor-amd64.zip + ./docker/upload-gh-asset.sh github_api_token=${{ secrets.BOT_TOKEN }} owner=netboxlabs repo=pktvisor tag=LATEST filename=./pktvisor-amd64.zip - name: Get branch name shell: bash @@ -490,12 +490,11 @@ jobs: - name: Debug ref tag run: echo ${{ env.REF_TAG }} - - name: Login to GitHub Container Registry + - name: Login to Docker Hub uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Set up Docker Buildx id: buildx @@ -516,70 +515,21 @@ jobs: - name: Build + push - pktvisor (multi-arch) env: - IMAGE_NAME: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 #v6.10.0 with: builder: ${{ steps.buildx.outputs.name }} context: . file: ./docker/Dockerfile.crashhandler platforms: linux/amd64 - tags: ${{ env.IMAGE_NAME }}:release-amd64 + tags: ${{ env.IMAGE_NAME }}:latest, ${{ env.IMAGE_NAME }}:${{ env.VERSION }} outputs: type=docker,dest=/tmp/amd64.tar - name: Load image env: - IMAGE_NAME: ghcr.io/orb-community/pktvisor + IMAGE_NAME: netboxlabs/pktvisor run: | docker load --input /tmp/amd64.tar docker image ls -a - docker push ${{ env.IMAGE_NAME }}:release-amd64 - - - pushing-manifests: - needs: [ package-amd64 , package-arm64 ] - runs-on: ubuntu-latest - if: github.event_name != 'pull_request' - steps: - - name: Login to GitHub Container Registry - uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 #v3.3.0 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Create docker manifest - run: | - docker manifest create ghcr.io/orb-community/pktvisor:latest \ - ghcr.io/orb-community/pktvisor:release-amd64 \ - ghcr.io/orb-community/pktvisor:release-arm64 - - - name: Push manifest to ghcr.io - run: | - docker manifest push ghcr.io/orb-community/pktvisor:latest - - - name: Install skopeo - run: | - sudo apt-get update - sudo apt-get install -y skopeo - - - name: Login skopeo to ghcr - run: | - sudo skopeo login -u ${{ github.repository_owner }} -p ${{ secrets.GITHUB_TOKEN }} ghcr.io - - - name: Login skopeo to dockerhub - run: | - sudo skopeo login -u ${{ secrets.ORB_DOCKERHUB_USERNAME }} -p ${{ secrets.ORB_DOCKERHUB_TOKEN }} docker.io - - - name: Copy latest from ghcr.io to docker.io - run: | - sudo skopeo copy \ - --all \ - docker://ghcr.io/orb-community/pktvisor:latest \ - docker://docker.io/orbcommunity/pktvisor:latest - - - name: Copy release version from ghcr.io to docker.io - run: | - sudo skopeo copy \ - --all \ - docker://ghcr.io/orb-community/pktvisor:latest \ - docker://docker.io/orbcommunity/pktvisor:${{ needs.package-amd64.outputs.release_version }} + docker push ${{ env.IMAGE_NAME }}:latest + docker push ${{ env.IMAGE_NAME }}:${{ env.VERSION }} \ No newline at end of file diff --git a/.github/workflows/build_debug.yml b/.github/workflows/build_debug.yml index cd2451b9f..cc21e9325 100644 --- a/.github/workflows/build_debug.yml +++ b/.github/workflows/build_debug.yml @@ -188,7 +188,7 @@ jobs: - name: Build, push debug image + crashhandler env: - IMAGE_NAME: orbcommunity/pktvisor + IMAGE_NAME: netboxlabs/pktvisor run: | docker build . --file docker/Dockerfile.crashhandler --tag ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} docker push -a ${{ env.IMAGE_NAME }} diff --git a/.github/workflows/code-ql.yml b/.github/workflows/code-ql.yml index 4a8ab3720..f48044c8e 100644 --- a/.github/workflows/code-ql.yml +++ b/.github/workflows/code-ql.yml @@ -96,7 +96,7 @@ jobs: LDFLAGS=${{matrix.ldflags}} EOF # clone the repository, not sure if this needs to be done - git clone https://github.com/orb-community/pktvisor.git + git clone https://github.com/netboxlabs/pktvisor.git cd pktvisor mkdir build && cd build # configure and handle dependencies diff --git a/README.md b/README.md index ce27331d2..4be69fa1a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ ![pktvisor](docs/images/pktvisor-header.png) -[![Build status](https://github.com/orb-community/pktvisor/workflows/Build/badge.svg)](https://github.com/orb-community/pktvisor/actions) -[![CodeQL](https://github.com/orb-community/pktvisor/workflows/CodeQL/badge.svg)](https://github.com/orb-community/pktvisor/security/code-scanning) -[![CodeCov](https://codecov.io/gh/orb-community/pktvisor/branch/develop/graph/badge.svg)](https://app.codecov.io/gh/orb-community/pktvisor/tree/develop) +[![Build status](https://github.com/netboxlabs/pktvisor/workflows/Build/badge.svg)](https://github.com/netboxlabs/pktvisor/actions) +[![CodeQL](https://github.com/netboxlabs/pktvisor/workflows/CodeQL/badge.svg)](https://github.com/netboxlabs/pktvisor/security/code-scanning) +[![CodeCov](https://codecov.io/gh/netboxlabs/pktvisor/branch/develop/graph/badge.svg)](https://app.codecov.io/gh/netboxlabs/pktvisor/tree/develop)

@@ -38,7 +38,7 @@ The [stream analyzer system](src/handlers) includes full application layer analy * Set Cardinality * GeoIP/ASN -Please see the list of [current metrics](https://github.com/orb-community/pktvisor/wiki/Current-Metrics) or the [sample metric output](https://github.com/orb-community/pktvisor/wiki/Sample-pktvisor-Output-Data). +Please see the list of [current metrics](https://github.com/netboxlabs/pktvisor/wiki/Current-Metrics) or the [sample metric output](https://github.com/netboxlabs/pktvisor/wiki/Sample-pktvisor-Output-Data). pktvisor has its origins in observability of critical internet infrastructure in support of DDoS protection, traffic engineering, and ongoing operations. @@ -55,17 +55,17 @@ the [Network](src/handlers/net) and [DNS](src/handlers/dns) stream processors, a ### Docker One of the easiest ways to get started with pktvisor is to use -the [public docker image](https://hub.docker.com/r/orbcommunity/pktvisor). The image contains the collector +the [public docker image](https://hub.docker.com/r/netboxlabs/pktvisor). The image contains the collector agent (`pktvisord`), the command line UI (`pktvisor-cli`) and the pcap and dnstap file analyzer (`pktvisor-reader`). When running the container, you specify which tool to run. 1. *Pull the container* ``` -docker pull orbcommunity/pktvisor +docker pull netboxlabs/pktvisor ``` -or use `orbcommunity/pktvisor:latest-develop` to get the latest development version. +or use `netboxlabs/pktvisor:latest-develop` to get the latest development version. 2. *Start the collector agent* @@ -75,7 +75,7 @@ _Note that this step requires docker host networking_ to observe traffic outside that [currently only Linux supports host networking](https://docs.docker.com/network/host/): ``` -docker run --net=host -d orbcommunity/pktvisor pktvisord eth0 +docker run --net=host -d netboxlabs/pktvisor pktvisord eth0 ``` If the container does not stay running, check the `docker logs` output. @@ -87,13 +87,13 @@ UI (`pktvisor-cli`) in the foreground, and exit when Ctrl-C is pressed. It conne the built in REST API. ``` -docker run -it --rm --net=host orbcommunity/pktvisor pktvisor-cli +docker run -it --rm --net=host netboxlabs/pktvisor pktvisor-cli ``` ### Linux Static Binary (AppImage, x86_64) You may also use the Linux all-in-one binary, built with [AppImage](https://appimage.org/), which is available for -download [on the Releases page](https://github.com/orb-community/pktvisor/releases). It is designed to work on all modern +download [on the Releases page](https://github.com/netboxlabs/pktvisor/releases). It is designed to work on all modern Linux distributions and does not require installation or any other dependencies. ```shell @@ -168,7 +168,7 @@ sudo setcap cap_net_raw,cap_net_admin=eip //pktvisord-x86_64 Current command line options are described with: ``` -docker run --rm orbcommunity/pktvisor pktvisord --help +docker run --rm netboxlabs/pktvisor pktvisord --help ``` or @@ -302,7 +302,7 @@ visor: config: only_qname_suffix: - ".google.com" - - ".ns1.com" + - ".netboxlabs.com" mytcp: kind: collection input: @@ -320,7 +320,7 @@ If running in a Docker container, you must mount the configuration file into the is on the host at `/local/pktvisor/agent.yaml`, you can mount it into the container and use it with this command: ```shell -docker run -v /local/pktvisor:/usr/local/pktvisor/ --net=host orbcommunity/pktvisor pktvisord --config /usr/local/pktvisor/agent.yaml --admin-api +docker run -v /local/pktvisor:/usr/local/pktvisor/ --net=host netboxlabs/pktvisor pktvisord --config /usr/local/pktvisor/agent.yaml --admin-api ``` @@ -331,7 +331,7 @@ summarization, which is by default a sliding 5 minute time window. It can also c host. ``` -docker run --rm orbcommunity/pktvisor pktvisor-cli -h +docker run --rm netboxlabs/pktvisor pktvisor-cli -h ``` ```shell @@ -367,7 +367,7 @@ using a tool such as [golang-dnstap](https://github.com/dnstap/golang-dnstap). Both take many of the same options, and do all of the same analysis, as `pktvisord` for live capture. pcap files may include Flow capture data. ``` -docker run --rm orbcommunity/pktvisor pktvisor-reader --help +docker run --rm netboxlabs/pktvisor pktvisor-reader --help ``` ```shell @@ -404,7 +404,7 @@ You can use the docker container by passing in a volume referencing the director output will contain the JSON summarization output, which you can capture or pipe into other tools, for example: ``` -$ docker run --rm -v /pktvisor/src/tests/fixtures:/pcaps orbcommunity/pktvisor pktvisor-reader /pcaps/dns_ipv4_udp.pcap | jq . +$ docker run --rm -v /pktvisor/src/tests/fixtures:/pcaps netboxlabs/pktvisor pktvisor-reader /pcaps/dns_ipv4_udp.pcap | jq . [2021-03-11 18:45:04.572] [pktvisor] [info] Load input plugin: PcapInputModulePlugin dev.visor.module.input/1.0 [2021-03-11 18:45:04.573] [pktvisor] [info] Load handler plugin: DnsHandler dev.visor.module.handler/1.0 @@ -524,14 +524,14 @@ You can set the `instance` label by passing `--prom-instance ID` If you are interested in centralized collection using [remote write](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage), including to -cloud providers, there is a [docker image available](https://hub.docker.com/r/orbcommunity/pktvisor-prom-write) to make this +cloud providers, there is a [docker image available](https://hub.docker.com/r/netboxlabs/pktvisor-prom-write) to make this easy. See [centralized_collection/prometheus](centralized_collection/prometheus) for more. Also see [getorb.io](https://getorb.io) for information on connecting pktvisor agents to the Orb observability platform. ### REST API -REST API documentation is available in [OpenAPI Format](https://app.swaggerhub.com/apis/orb-community/pktvisor/3.0.0-oas3) +REST API documentation is available in [OpenAPI Format](https://app.swaggerhub.com/apis/netboxlabs/pktvisor/3.0.0-oas3) Please note that the administration control plane API (`--admin-api`) is currently undergoing heavy iteration and so is not yet documented. If you have a use case that requires the administration API, please [contact us](#contact-us) to @@ -545,7 +545,7 @@ ingress and egress traffic: ``` docker run --rm --net=host -d \ --mount type=bind,source=/opt/geo,target=/geo \ - orbcommunity/pktvisor pktvisord \ + netboxlabs/pktvisor pktvisord \ --geo-city /geo/GeoIP2-City.mmdb \ --geo-asn /geo/GeoIP2-ISP.mmdb \ -H 192.168.0.54/32,127.0.0.1/32 \ @@ -574,10 +574,10 @@ Please [contact us](#contact-us) if you have any questions on installation, use, We are very interested in hearing about your use cases, feature requests, and other feedback! -* [File an issue](https://github.com/orb-community/pktvisor/issues/new) -* See existing [issues](https://github.com/orb-community/pktvisor/issues) -* Start a [Discussion](https://github.com/orb-community/pktvisor/discussions) -* [Join us on Slack](https://join.slack.com/t/orb-community/shared_invite/zt-qqsm5cb4-9fsq1xa~R3h~nX6W0sJzmA) +* [File an issue](https://github.com/netboxlabs/pktvisor/issues/new) +* See existing [issues](https://github.com/netboxlabs/pktvisor/issues) +* Start a [Discussion](https://github.com/netboxlabs/pktvisor/discussions) +* [Join us on Slack](https://join.slack.com/t/netboxlabs/shared_invite/zt-qqsm5cb4-9fsq1xa~R3h~nX6W0sJzmA) * Send mail to [info@pktvisor.dev](mailto:info@pktvisor.dev) ## Build @@ -603,7 +603,7 @@ The general build steps are: ``` # clone the repository -git clone https://github.com/orb-community/pktvisor.git +git clone https://github.com/netboxlabs/pktvisor.git cd pktvisor mkdir build && cd build @@ -618,8 +618,8 @@ bin/pktvisord --help ``` As development environments can vary widely, please see -the [Dockerfile](https://github.com/orb-community/pktvisor/blob/master/docker/Dockerfile) -and [Continuous Integration build file](https://github.com/orb-community/pktvisor/blob/master/.github/workflows/build.yml) for +the [Dockerfile](https://github.com/netboxlabs/pktvisor/blob/master/docker/Dockerfile) +and [Continuous Integration build file](https://github.com/netboxlabs/pktvisor/blob/master/.github/workflows/build.yml) for reference. ## Contribute diff --git a/RFCs/2022-06-23-307-config.md b/RFCs/2022-06-23-307-config.md index bb0b715e6..9444cb4a6 100644 --- a/RFCs/2022-06-23-307-config.md +++ b/RFCs/2022-06-23-307-config.md @@ -5,7 +5,7 @@ ## Summary -Pktvisord binary allows multiple [command line arguments](https://github.com/orb-community/pktvisor#agent-usage) on its start up. Almost all the parameters can be passed to pktvisord +Pktvisord binary allows multiple [command line arguments](https://github.com/netboxlabs/pktvisor#agent-usage) on its start up. Almost all the parameters can be passed to pktvisord via yaml configuration file. Config file can also be combined with command line arguments. Moreover, the config file has a feature to allow setup of global configuration for specific handlers (`global_handler_config`). diff --git a/appimage/Makefile b/appimage/Makefile index bf1c1d0f2..e4dc503a4 100644 --- a/appimage/Makefile +++ b/appimage/Makefile @@ -1,4 +1,4 @@ -DEV_IMAGE ?= orbcommunity/pktvisor:latest +DEV_IMAGE ?= netboxlabs/pktvisor:latest # in dev mode we just use the latest image as the start point ifneq ($(strip $(DEV_MODE)),) diff --git a/appimage/README.md b/appimage/README.md index 74207345e..07315a84a 100644 --- a/appimage/README.md +++ b/appimage/README.md @@ -14,7 +14,7 @@ Because the build can take a while you may want to build the appimage from the l You may also specify a custom image in dev mode by setting the env file `DEV_IMAGE=` to the image you wish to build on. Example: -`DEV_IMAGE="orbcommunity/pktvisor:develop" DEV_MODE=t make pktvisor-x86_64.AppImage` +`DEV_IMAGE="netboxlabs/pktvisor:develop" DEV_MODE=t make pktvisor-x86_64.AppImage` ## Usage: diff --git a/appimage/pktvisor/TerminalEmulatorRequired.txt b/appimage/pktvisor/TerminalEmulatorRequired.txt index 960af1977..4997717ba 100644 --- a/appimage/pktvisor/TerminalEmulatorRequired.txt +++ b/appimage/pktvisor/TerminalEmulatorRequired.txt @@ -1 +1 @@ -This app needs to be run from a terminal to function correctly. See the docs at https://github.com/orb-community/pktvisor for more details. +This app needs to be run from a terminal to function correctly. See the docs at https://github.com/netboxlabs/pktvisor for more details. diff --git a/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_all_handlers.md b/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_all_handlers.md index 5374c98f1..8b7df80e6 100644 --- a/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_all_handlers.md +++ b/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_all_handlers.md @@ -1,6 +1,6 @@ ## Scenario: Create a policy using admin permission with all handlers ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Create a policy with all handlers through a post request on the endpoint: `/api/v1/policies` - Check our method `generate_pcap_policy_with_all_handlers` on [policies.py](../../features/steps/policies.py) in order to have examples of how to do it - Make a get request to the same endpoint diff --git a/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_only_one_handler.md b/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_only_one_handler.md index 05c68f058..14a7cd4fe 100644 --- a/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_only_one_handler.md +++ b/automated_tests/docs/pktvisor/create_a_policy_using_admin_permission_with_only_one_handler.md @@ -5,7 +5,7 @@ DNS: ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Create a policy with dns handler through a post request on the endpoint: `/api/v1/policies` - Make a get request to the same endpoint @@ -19,7 +19,7 @@ DNS: NET: ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Create a policy with net handler through a post request on the endpoint: `/api/v1/policies` - Make a get request to the same endpoint @@ -34,7 +34,7 @@ DHCP: ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Create a policy with dhcp handler through a post request on the endpoint: `/api/v1/policies` - Make a get request to the same endpoint @@ -48,7 +48,7 @@ PCAP: ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Create a policy with pcap handler through a post request on the endpoint: `/api/v1/policies` - Make a get request to the same endpoint diff --git a/automated_tests/docs/pktvisor/create_a_policy_without_admin_permission.md b/automated_tests/docs/pktvisor/create_a_policy_without_admin_permission.md index 358e694b5..9c53f7bdc 100644 --- a/automated_tests/docs/pktvisor/create_a_policy_without_admin_permission.md +++ b/automated_tests/docs/pktvisor/create_a_policy_without_admin_permission.md @@ -1,7 +1,7 @@ ## Scenario: Create a policy without admin permission ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord ` - Try to create a policy through a post request on the endpoint: `/api/v1/policies` - Make a get request to the same endpoint diff --git a/automated_tests/docs/pktvisor/remove_a_policy_without_admin_permission.md b/automated_tests/docs/pktvisor/remove_a_policy_without_admin_permission.md index 336363c3c..b7da10ea3 100644 --- a/automated_tests/docs/pktvisor/remove_a_policy_without_admin_permission.md +++ b/automated_tests/docs/pktvisor/remove_a_policy_without_admin_permission.md @@ -1,7 +1,7 @@ ## Scenario: Remove a policy without admin permission ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord ` - Try to remove the default policy through a DELETE request on the endpoint: `/api/v1/policies/{name_of_the_policy}` - Make a get request to the same endpoint diff --git a/automated_tests/docs/pktvisor/remove_policies_using_admin_permission_from_pktvisor_instance.md b/automated_tests/docs/pktvisor/remove_policies_using_admin_permission_from_pktvisor_instance.md index 689af9da1..e74f11a34 100644 --- a/automated_tests/docs/pktvisor/remove_policies_using_admin_permission_from_pktvisor_instance.md +++ b/automated_tests/docs/pktvisor/remove_policies_using_admin_permission_from_pktvisor_instance.md @@ -5,7 +5,7 @@ All policies ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Remove the default policy through a DELETE request on the endpoint: `/api/v1/policies/{name_of_the_policy}` - Make a get request to the same endpoint @@ -20,7 +20,7 @@ One policy ## Steps: -- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord --admin-api ` - Create a policy with all handlers through a post request on the endpoint: `/api/v1/policies` - Check our method `generate_pcap_policy_with_all_handlers` on [policies.py](../../features/steps/policies.py) in order to have examples of how to do it - Remove one of the running policies using a DELETE request on the endpoint: `/api/v1/policies/{name_of_the_policy}` diff --git a/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_different_ports.md b/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_different_ports.md index dc5eafa79..1eb8143b6 100644 --- a/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_different_ports.md +++ b/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_different_ports.md @@ -1,8 +1,8 @@ ## Scenario: Run multiple pktvisors instances using different ports ## Steps: -- Provide 1 pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` -- Provide 1 pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord -p 10854 ` +- Provide 1 pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord ` +- Provide 1 pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord -p 10854 ` ## Expected Result: diff --git a/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_the_same_ports.md b/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_the_same_ports.md index af41cc789..5bb28e275 100644 --- a/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_the_same_ports.md +++ b/automated_tests/docs/pktvisor/run_multiple_pktvisors_instances_using_the_same_ports.md @@ -1,8 +1,8 @@ ## Scenario: Run multiple pktvisors instances using the same ports ## Steps: -- Provide 1 pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` -- Provide 1 pktvisor instance using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` +- Provide 1 pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord ` +- Provide 1 pktvisor instance using `docker run --net=host -d netboxlabs/pktvisor pktvisord ` ## Expected Result: diff --git a/automated_tests/docs/pktvisor/run_pktvisor_instance_using_docker_command.md b/automated_tests/docs/pktvisor/run_pktvisor_instance_using_docker_command.md index 773747ab0..1f90b6431 100644 --- a/automated_tests/docs/pktvisor/run_pktvisor_instance_using_docker_command.md +++ b/automated_tests/docs/pktvisor/run_pktvisor_instance_using_docker_command.md @@ -1,6 +1,6 @@ ## Scenario: Run pktvisor instance using docker command ## Steps: - - Run docker using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` + - Run docker using `docker run --net=host -d netboxlabs/pktvisor pktvisord ` ## Expected Result: diff --git a/automated_tests/features/steps/test_config.py b/automated_tests/features/steps/test_config.py index 83778ea46..622a661d2 100644 --- a/automated_tests/features/steps/test_config.py +++ b/automated_tests/features/steps/test_config.py @@ -30,7 +30,7 @@ def _read_configs(): configs['sudo'] = "True" assert_that(configs.get('sudo_password'), not_none(), 'Sudo password was not provided!') client = docker.from_env() - configs['pktvisor_docker_image'] = f"orbcommunity/pktvisor:{configs.get('pktvisor_docker_image_tag', 'latest')}" + configs['pktvisor_docker_image'] = f"netboxlabs/pktvisor:{configs.get('pktvisor_docker_image_tag', 'latest')}" try: client.images.get(configs['pktvisor_docker_image']) except ImageNotFound: diff --git a/centralized_collection/elastic/docker/with_telegraf/Dockerfile b/centralized_collection/elastic/docker/with_telegraf/Dockerfile index 6dc2502c8..b86e39e9b 100644 --- a/centralized_collection/elastic/docker/with_telegraf/Dockerfile +++ b/centralized_collection/elastic/docker/with_telegraf/Dockerfile @@ -1,7 +1,7 @@ ARG PKTVISOR_TAG=latest FROM telegraf:1.16.2 as telegraf -FROM orbcommunity/pktvisor:${PKTVISOR_TAG} +FROM netboxlabs/pktvisor:${PKTVISOR_TAG} COPY --from=telegraf /usr/bin/telegraf /usr/local/bin/telegraf diff --git a/centralized_collection/prometheus/README.md b/centralized_collection/prometheus/README.md index 09e53c049..d2cc01ad8 100644 --- a/centralized_collection/prometheus/README.md +++ b/centralized_collection/prometheus/README.md @@ -1,7 +1,7 @@ # Centralized Prometheus Collection This directory contains resources for building a docker container aiding centralized prometheus collection. It is -published to Docker hub at https://hub.docker.com/r/orbcommunity/pktvisor-prom-write +published to Docker hub at https://hub.docker.com/r/netboxlabs/pktvisor-prom-write It combines pktvisord with the [Grafana Agent](https://github.com/grafana/agent) for collecting and sending metrics to Prometheus through @@ -16,19 +16,19 @@ Grafana installation (ID 14221). Example: ```shell -docker pull orbcommunity/pktvisor-prom-write +docker pull netboxlabs/pktvisor-prom-write docker run -d --net=host --env PKTVISORD_ARGS="--prom-instance " \ --env REMOTE_URL="https:///api/prom/push" --env USERNAME="" \ ---env PASSWORD="" orbcommunity/pktvisor-prom-write +--env PASSWORD="" netboxlabs/pktvisor-prom-write ``` Example with Geo enabled (assuming files are located in `/usr/local/geo`): ```shell -docker pull orbcommunity/pktvisor-prom-write +docker pull netboxlabs/pktvisor-prom-write docker run -d --mount type=bind,source=/usr/local/geo,target=/geo --net=host --env \ PKTVISORD_ARGS="--prom-instance --geo-city /geo/GeoIP2-City.mmdb --geo-asn /geo/GeoIP2-ISP.mmdb " \ ---env REMOTE_URL="https:///api/prom/push" --env USERNAME="" --env PASSWORD="" orbcommunity/pktvisor-prom-write +--env REMOTE_URL="https:///api/prom/push" --env USERNAME="" --env PASSWORD="" netboxlabs/pktvisor-prom-write ``` **PKTVISORD_ARGS optionally allows a semicolon delimited list of arguments to handle arguments such as bpf filters that may contain whitespace* @@ -36,10 +36,10 @@ PKTVISORD_ARGS="--prom-instance --geo-city /geo/GeoIP2-City.mmdb --ge Example with Geo enabled and bpf filter (assuming files are located in `/usr/local/geo`): ```shell -docker pull orbcommunity/pktvisor-prom-write +docker pull netboxlabs/pktvisor-prom-write docker run -d --mount type=bind,source=/usr/local/geo,target=/geo --net=host --env \ PKTVISORD_ARGS="-b; port 53; --prom-instance; ; --geo-city; /geo/GeoIP2-City.mmdb; --geo-asn; /geo/GeoIP2-ISP.mmdb; " \ ---env REMOTE_URL="https:///api/prom/push" --env USERNAME="" --env PASSWORD="" orbcommunity/pktvisor-prom-write +--env REMOTE_URL="https:///api/prom/push" --env USERNAME="" --env PASSWORD="" netboxlabs/pktvisor-prom-write ``` There are a several pieces of information you need to substitute above: diff --git a/centralized_collection/prometheus/docker-grafana-agent/Dockerfile b/centralized_collection/prometheus/docker-grafana-agent/Dockerfile index f1ab1565d..778bde658 100644 --- a/centralized_collection/prometheus/docker-grafana-agent/Dockerfile +++ b/centralized_collection/prometheus/docker-grafana-agent/Dockerfile @@ -1,7 +1,7 @@ ARG PKTVISOR_TAG=latest FROM grafana/agent:latest as agent -FROM orbcommunity/pktvisor:${PKTVISOR_TAG} +FROM netboxlabs/pktvisor:${PKTVISOR_TAG} COPY --from=agent /bin/grafana-agent /usr/local/bin/agent diff --git a/docker/Makefile b/docker/Makefile index bfabf258a..33077a9f1 100644 --- a/docker/Makefile +++ b/docker/Makefile @@ -4,4 +4,4 @@ # for developer environments (e.g. clion docker toolchain) # note does not require/include the source base pktvisor: - docker build -t orbcommunity/pktvisor -f ./Dockerfile .. + docker build -t netboxlabs/pktvisor -f ./Dockerfile .. diff --git a/docker/entry-cp.sh b/docker/entry-cp.sh index 8c54b33d9..5c9f3fa66 100755 --- a/docker/entry-cp.sh +++ b/docker/entry-cp.sh @@ -14,9 +14,9 @@ trap trapeze SIGINT if [ $# -eq 0 ]; then echo "No arguments provided: specify either 'pktvisor-cli', 'pktvisor-reader' or 'pktvisord'. Try:" - echo "docker run orbcommunity/pktvisor pktvisor-cli -h" - echo "docker run orbcommunity/pktvisor pktvisor-reader --help" - echo "docker run orbcommunity/pktvisor pktvisord --help" + echo "docker run netboxlabs/pktvisor pktvisor-cli -h" + echo "docker run netboxlabs/pktvisor pktvisor-reader --help" + echo "docker run netboxlabs/pktvisor pktvisord --help" exit 1 fi