From 3059378bbc67738f23611dd4ddeed57aac5aec06 Mon Sep 17 00:00:00 2001 From: manrodrigues Date: Fri, 31 Mar 2023 14:17:00 -0300 Subject: [PATCH 01/10] files referring to ns1labs --- .github/workflows/build-develop.yml | 10 +++---- .github/workflows/build-release.yml | 4 +-- .github/workflows/clean-runners.yml | 2 +- .github/workflows/code-ql.yml | 4 +-- .github/workflows/debug_build.yml | 2 +- README.md | 26 +++++++++---------- RFCs/2022-06-23-307-config.md | 2 +- appimage/Makefile | 2 +- appimage/README.md | 2 +- .../pktvisor/TerminalEmulatorRequired.txt | 2 +- .../elastic/docker/with_telegraf/Dockerfile | 2 +- centralized_collection/prometheus/README.md | 14 +++++----- .../docker-grafana-agent/Dockerfile | 2 +- docker/Dockerfile | 4 +-- docker/Dockerfile.clang-toolchain | 2 +- docker/Dockerfile.crashhandler | 4 +-- docker/Dockerfile.pktvisor-reader-static | 2 +- docker/Dockerfile.pktvisord-static | 2 +- docker/Dockerfile.static-base | 8 +++--- docker/entry-cp.sh | 6 ++--- docker/entry.sh | 6 ++--- docs/index.html | 2 +- docs/pktvisor-3.0.0-oas3-swagger.yaml | 2 +- 23 files changed, 56 insertions(+), 56 deletions(-) diff --git a/.github/workflows/build-develop.yml b/.github/workflows/build-develop.yml index 927acaf5d..00d3e7ded 100644 --- a/.github/workflows/build-develop.yml +++ b/.github/workflows/build-develop.yml @@ -354,7 +354,7 @@ jobs: - name: Build + push - pktvisor (multi-arch) env: - IMAGE_NAME: ns1labs/pktvisor + IMAGE_NAME: orbcommunity/pktvisor IMAGE_NAME1: orbcommunity/pktvisor IMAGE_NAME2: ghcr.io/orb-community/pktvisor uses: docker/build-push-action@v3 @@ -368,7 +368,7 @@ jobs: - name: Load image env: - IMAGE_NAME: ns1labs/pktvisor + IMAGE_NAME: orbcommunity/pktvisor IMAGE_NAME1: orbcommunity/pktvisor IMAGE_NAME2: ghcr.io/orb-community/pktvisor run: | @@ -1015,15 +1015,15 @@ jobs: sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest-develop \ - docker://docker.io/ns1labs/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/ns1labs/pktvisor:develop + docker://docker.io/orbcommunity/pktvisor:develop sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest-develop \ - docker://docker.io/ns1labs/pktvisor:${{ needs.unit-tests-linux.outputs.version_number }} + docker://docker.io/orbcommunity/pktvisor:${{ needs.unit-tests-linux.outputs.version_number }} sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest-develop \ diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml index 6059e09ec..89fa93f07 100644 --- a/.github/workflows/build-release.yml +++ b/.github/workflows/build-release.yml @@ -987,7 +987,7 @@ jobs: sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest \ - docker://docker.io/ns1labs/pktvisor:latest + docker://docker.io/orbcommunity/pktvisor:latest sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest \ @@ -998,7 +998,7 @@ jobs: sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest \ - docker://docker.io/ns1labs/pktvisor:${{ needs.package-amd64.outputs.release_version }} + docker://docker.io/orbcommunity/pktvisor:${{ needs.package-amd64.outputs.release_version }} sudo skopeo copy \ --all \ docker://ghcr.io/orb-community/pktvisor:latest \ diff --git a/.github/workflows/clean-runners.yml b/.github/workflows/clean-runners.yml index f0663b156..0fff3a5c4 100644 --- a/.github/workflows/clean-runners.yml +++ b/.github/workflows/clean-runners.yml @@ -14,7 +14,7 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }} run: | - gh api -H "Accept: application/vnd.github.v3+json" /repos/ns1labs/pktvisor/actions/runners -q '.runners[] | {id,status,busy} | select((.busy == false) and (.status == "offline")) | {id} | .[]' --paginate | xargs -I {} gh api --method DELETE -H "Accept: application/vnd.github.v3+json" /repos/ns1labs/pktvisor/actions/runners/{} + gh api -H "Accept: application/vnd.github.v3+json" /repos/orb-community/pktvisor/actions/runners -q '.runners[] | {id,status,busy} | select((.busy == false) and (.status == "offline")) | {id} | .[]' --paginate | xargs -I {} gh api --method DELETE -H "Accept: application/vnd.github.v3+json" /repos/orb-community/pktvisor/actions/runners/{} # - name: Clear cache # uses: actions/github-script@v6 diff --git a/.github/workflows/code-ql.yml b/.github/workflows/code-ql.yml index a8d0e81d0..a11a917d2 100644 --- a/.github/workflows/code-ql.yml +++ b/.github/workflows/code-ql.yml @@ -68,7 +68,7 @@ jobs: # create conan config CONAN_V2_MODE=1 conan config init conan config set general.revisions_enabled=1 - conan remote add ns1labs https://ns1labs.jfrog.io/artifactory/api/conan/ns1labs-conan + conan remote add orbcommunity https://orbcommunity.jfrog.io/artifactory/api/conan/orbcommunity-conan # add custom compiler settings for libc python3 -c 'import yaml; p = "${{env.CONAN_USER_HOME}}/.conan/settings.yml"; d = yaml.safe_load(open(p)); d["compiler"]["gcc"]["libc"] = ["None", "glibc", "musl"]; yaml.safe_dump(d, open(p, "w"))' # Create Conan host profile @@ -92,7 +92,7 @@ jobs: LDFLAGS=${{matrix.ldflags}} EOF # clone the repository, not sure if this needs to be done - git clone https://github.com/ns1labs/pktvisor.git + git clone https://github.com/orb-community/pktvisor.git cd pktvisor mkdir build && cd build # configure and handle dependencies diff --git a/.github/workflows/debug_build.yml b/.github/workflows/debug_build.yml index 13a40d241..5df2f4475 100644 --- a/.github/workflows/debug_build.yml +++ b/.github/workflows/debug_build.yml @@ -190,7 +190,7 @@ jobs: - name: Build, push debug image + crashhandler env: - IMAGE_NAME: ns1labs/pktvisor + IMAGE_NAME: orbcommunity/pktvisor IMAGE_NAME1: orbcommunity/pktvisor run: | docker build . --file docker/Dockerfile.crashhandler --tag ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} --tag ${{ env.IMAGE_NAME1 }}:${{ env.REF_TAG }} diff --git a/README.md b/README.md index 2b6373909..2ed1deb90 100644 --- a/README.md +++ b/README.md @@ -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/ns1labs/pktvisor). The image contains the collector +the [public docker image](https://hub.docker.com/r/orbcommunity/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 ns1labs/pktvisor +docker pull orbcommunity/pktvisor ``` -or use `ns1labs/pktvisor:latest-develop` to get the latest development version. +or use `orbcommunity/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 ns1labs/pktvisor pktvisord eth0 +docker run --net=host -d orbcommunity/pktvisor pktvisord eth0 ``` If the container does not stay running, check the `docker logs` output. @@ -87,7 +87,7 @@ 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 ns1labs/pktvisor pktvisor-cli +docker run -it --rm --net=host orbcommunity/pktvisor pktvisor-cli ``` ### Linux Static Binary (AppImage, x86_64) @@ -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 ns1labs/pktvisor pktvisord --help +docker run --rm orbcommunity/pktvisor pktvisord --help ``` or @@ -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 ns1labs/pktvisor pktvisord --config /usr/local/pktvisor/agent.yaml --admin-api +docker run -v /local/pktvisor:/usr/local/pktvisor/ --net=host orbcommunity/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 ns1labs/pktvisor pktvisor-cli -h +docker run --rm orbcommunity/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 ns1labs/pktvisor pktvisor-reader --help +docker run --rm orbcommunity/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 ns1labs/pktvisor pktvisor-reader /pcaps/dns_ipv4_udp.pcap | jq . +$ docker run --rm -v /pktvisor/src/tests/fixtures:/pcaps orbcommunity/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/ns1labs/pktvisor-prom-write) to make this +cloud providers, there is a [docker image available](https://hub.docker.com/r/orbcommunity/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/ns1labs/pktvisor/3.0.0-oas3) +REST API documentation is available in [OpenAPI Format](https://app.swaggerhub.com/apis/orbcommunity/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 \ - ns1labs/pktvisor pktvisord \ + orbcommunity/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 \ diff --git a/RFCs/2022-06-23-307-config.md b/RFCs/2022-06-23-307-config.md index 3d6121985..bb0b715e6 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/ns1labs/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/orb-community/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 085a7079c..bf1c1d0f2 100644 --- a/appimage/Makefile +++ b/appimage/Makefile @@ -1,4 +1,4 @@ -DEV_IMAGE ?= ns1labs/pktvisor:latest +DEV_IMAGE ?= orbcommunity/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 c6b2d808b..74207345e 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="ns1labs/pktvisor:develop" DEV_MODE=t make pktvisor-x86_64.AppImage` +`DEV_IMAGE="orbcommunity/pktvisor:develop" DEV_MODE=t make pktvisor-x86_64.AppImage` ## Usage: diff --git a/appimage/pktvisor/TerminalEmulatorRequired.txt b/appimage/pktvisor/TerminalEmulatorRequired.txt index 7f0d9f302..3aab6fbd3 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/ns1labs/pktvisor for more details. \ No newline at end of file +This app needs to be run from a terminal to function correctly. See the docs at https://github.com/orbcommunity/pktvisor for more details. \ No newline at end of file diff --git a/centralized_collection/elastic/docker/with_telegraf/Dockerfile b/centralized_collection/elastic/docker/with_telegraf/Dockerfile index d7c64d9a1..6dc2502c8 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 ns1labs/pktvisor:${PKTVISOR_TAG} +FROM orbcommunity/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 7a969b069..09e53c049 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/ns1labs/pktvisor-prom-write +published to Docker hub at https://hub.docker.com/r/orbcommunity/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 ns1labs/pktvisor-prom-write +docker pull orbcommunity/pktvisor-prom-write docker run -d --net=host --env PKTVISORD_ARGS="--prom-instance " \ --env REMOTE_URL="https:///api/prom/push" --env USERNAME="" \ ---env PASSWORD="" ns1labs/pktvisor-prom-write +--env PASSWORD="" orbcommunity/pktvisor-prom-write ``` Example with Geo enabled (assuming files are located in `/usr/local/geo`): ```shell -docker pull ns1labs/pktvisor-prom-write +docker pull orbcommunity/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="" ns1labs/pktvisor-prom-write +--env REMOTE_URL="https:///api/prom/push" --env USERNAME="" --env PASSWORD="" orbcommunity/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 ns1labs/pktvisor-prom-write +docker pull orbcommunity/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="" ns1labs/pktvisor-prom-write +--env REMOTE_URL="https:///api/prom/push" --env USERNAME="" --env PASSWORD="" orbcommunity/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 9dae75965..59435f097 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 ns1labs/pktvisor:${PKTVISOR_TAG} +FROM orbcommunity/pktvisor:${PKTVISOR_TAG} COPY --from=agent /bin/agent /usr/local/bin/agent diff --git a/docker/Dockerfile b/docker/Dockerfile index 459370e50..44b82b7ad 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -50,8 +50,8 @@ RUN \ #create dir and download geo db RUN mkdir /geo-db -RUN cd /geo-db && wget https://github.com/ns1labs/geo-asn-database/raw/main/asn.mmdb.gz -RUN cd /geo-db && wget https://github.com/ns1labs/geo-asn-database/raw/main/city.mmdb.gz +RUN cd /geo-db && wget https://github.com/orb-community/geo-asn-database/raw/main/asn.mmdb.gz +RUN cd /geo-db && wget https://github.com/orb-community/geo-asn-database/raw/main/city.mmdb.gz RUN mkdir /iana COPY --from=cppbuild /pktvisor-src/src/tests/fixtures/pktvisor-port-service-names.csv /iana/custom-iana.csv diff --git a/docker/Dockerfile.clang-toolchain b/docker/Dockerfile.clang-toolchain index 61b65fe53..4e4f27a57 100644 --- a/docker/Dockerfile.clang-toolchain +++ b/docker/Dockerfile.clang-toolchain @@ -1,4 +1,4 @@ -FROM ns1labs/clang-toolchain:latest +FROM orbcommunity/clang-toolchain:latest ARG REQUIRE="make cmake python3 py3-pip perl git bash libexecinfo-static libexecinfo-dev" ARG UID=1000 diff --git a/docker/Dockerfile.crashhandler b/docker/Dockerfile.crashhandler index d33f892f0..4295f2088 100644 --- a/docker/Dockerfile.crashhandler +++ b/docker/Dockerfile.crashhandler @@ -18,8 +18,8 @@ COPY ./docker/run.sh /run.sh #create dir and download geo db RUN mkdir /geo-db -RUN cd /geo-db && wget https://github.com/ns1labs/geo-asn-database/raw/main/asn.mmdb.gz -RUN cd /geo-db && wget https://github.com/ns1labs/geo-asn-database/raw/main/city.mmdb.gz +RUN cd /geo-db && wget https://github.com/orb-community/geo-asn-database/raw/main/asn.mmdb.gz +RUN cd /geo-db && wget https://github.com/orb-community/geo-asn-database/raw/main/city.mmdb.gz #create dir and setup iana csv RUN mkdir /iana diff --git a/docker/Dockerfile.pktvisor-reader-static b/docker/Dockerfile.pktvisor-reader-static index b1d4ae0b2..00a0ec727 100644 --- a/docker/Dockerfile.pktvisor-reader-static +++ b/docker/Dockerfile.pktvisor-reader-static @@ -1,4 +1,4 @@ -FROM ns1labs/static-base AS cppbuild +FROM orbcommunity/static-base AS cppbuild FROM scratch AS runtime diff --git a/docker/Dockerfile.pktvisord-static b/docker/Dockerfile.pktvisord-static index 72637d926..6ef3047e6 100644 --- a/docker/Dockerfile.pktvisord-static +++ b/docker/Dockerfile.pktvisord-static @@ -1,4 +1,4 @@ -FROM ns1labs/static-base AS cppbuild +FROM orbcommunity/static-base AS cppbuild FROM scratch AS runtime diff --git a/docker/Dockerfile.static-base b/docker/Dockerfile.static-base index de7a909ae..75164df45 100644 --- a/docker/Dockerfile.static-base +++ b/docker/Dockerfile.static-base @@ -1,4 +1,4 @@ -FROM ns1labs/clang-toolchain:latest AS cppbuild +FROM orbcommunity/clang-toolchain:latest AS cppbuild ARG REQUIRE="make cmake python3 py3-pip perl git bash libexecinfo-static libexecinfo-dev" RUN apk add --no-cache ${REQUIRE} @@ -26,6 +26,6 @@ WORKDIR /tmp/build RUN cmake -DCMAKE_BUILD_TYPE=Release /pktvisor-src \ && make all test -j 4 -# after build, use this to upload conan packages to ns1labs jfrog server -# docker run --rm -it ns1labs/static-base -# CONAN_USER_HOME=/tmp/build/conan_home conan upload "*" --all -r ns1labs -c +# after build, use this to upload conan packages to orbcommunity jfrog server +# docker run --rm -it orbcommunity/static-base +# CONAN_USER_HOME=/tmp/build/conan_home conan upload "*" --all -r orbcommunity -c diff --git a/docker/entry-cp.sh b/docker/entry-cp.sh index 2e5761179..8c54b33d9 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 ns1labs/pktvisor pktvisor-cli -h" - echo "docker run ns1labs/pktvisor pktvisor-reader --help" - echo "docker run ns1labs/pktvisor pktvisord --help" + echo "docker run orbcommunity/pktvisor pktvisor-cli -h" + echo "docker run orbcommunity/pktvisor pktvisor-reader --help" + echo "docker run orbcommunity/pktvisor pktvisord --help" exit 1 fi diff --git a/docker/entry.sh b/docker/entry.sh index b65428857..e6401a2ae 100755 --- a/docker/entry.sh +++ b/docker/entry.sh @@ -7,9 +7,9 @@ export PATH=$PATH:/usr/local/bin/:/usr/local/sbin/ if [ $# -eq 0 ]; then echo "No arguments provided: specify either 'pktvisor-cli', 'pktvisor-reader' or 'pktvisord'. Try:" - echo "docker run ns1labs/pktvisor pktvisor-cli -h" - echo "docker run ns1labs/pktvisor pktvisor-reader --help" - echo "docker run ns1labs/pktvisor pktvisord --help" + echo "docker run orbcommunity/pktvisor pktvisor-cli -h" + echo "docker run orbcommunity/pktvisor pktvisor-reader --help" + echo "docker run orbcommunity/pktvisor pktvisord --help" exit 1 fi diff --git a/docs/index.html b/docs/index.html index f67ba00b9..ccdf93c0d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -181,7 +181,7 @@

pktvisor

pktvisor summarizes data streams in real time and provides a clean, time-windowed HTTP interface and command line UI to the results
More information: https://helloreverb.com
-
Contact Info: ns1labs@ns1.com
+
Contact Info: orbcommunity@ns1.com
Version: 3.0.0-oas3
Apache 2.0
diff --git a/docs/pktvisor-3.0.0-oas3-swagger.yaml b/docs/pktvisor-3.0.0-oas3-swagger.yaml index fa15b4d37..5137ab9bb 100644 --- a/docs/pktvisor-3.0.0-oas3-swagger.yaml +++ b/docs/pktvisor-3.0.0-oas3-swagger.yaml @@ -4,7 +4,7 @@ info: version: 3.0.0-oas3 title: pktvisor contact: - email: ns1labs@ns1.com + email: orbcommunity@ns1.com license: name: Apache 2.0 url: 'http://www.apache.org/licenses/LICENSE-2.0.html' From 0f8e92bc6edea8c96c8566a336893b9951d64744 Mon Sep 17 00:00:00 2001 From: manrodrigues Date: Wed, 5 Apr 2023 12:05:09 -0300 Subject: [PATCH 02/10] updating tests with new docker hub --- ...e_a_policy_using_admin_permission_with_all_handlers.md | 2 +- ...policy_using_admin_permission_with_only_one_handler.md | 8 ++++---- .../pktvisor/create_a_policy_without_admin_permission.md | 2 +- .../pktvisor/remove_a_policy_without_admin_permission.md | 2 +- ...icies_using_admin_permission_from_pktvisor_instance.md | 4 ++-- ..._multiple_pktvisors_instances_using_different_ports.md | 4 ++-- ...n_multiple_pktvisors_instances_using_the_same_ports.md | 4 ++-- .../run_pktvisor_instance_using_docker_command.md | 2 +- automated_tests/features/steps/test_config.py | 2 +- 9 files changed, 15 insertions(+), 15 deletions(-) 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 f61bad705..5374c98f1 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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 9327a0aa6..05c68f058 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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 f8c07ad83..358e694b5 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 ns1labs/pktvisor pktvisord ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 5705d6600..336363c3c 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 ns1labs/pktvisor pktvisord ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 d4e591463..689af9da1 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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 ns1labs/pktvisor pktvisord --admin-api ` +- Provide a pktvisor instance using `docker run --net=host -d orbcommunity/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 2ffe5238c..dc5eafa79 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 ns1labs/pktvisor pktvisord ` -- Provide 1 pktvisor instance using `docker run --net=host -d ns1labs/pktvisor pktvisord -p 10854 ` +- 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 ` ## 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 b4700513c..af41cc789 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 ns1labs/pktvisor pktvisord ` -- Provide 1 pktvisor instance using `docker run --net=host -d ns1labs/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 orbcommunity/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 3d6f73a84..773747ab0 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 ns1labs/pktvisor pktvisord ` + - Run docker using `docker run --net=host -d orbcommunity/pktvisor pktvisord ` ## Expected Result: diff --git a/automated_tests/features/steps/test_config.py b/automated_tests/features/steps/test_config.py index 91478cdca..83778ea46 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"ns1labs/pktvisor:{configs.get('pktvisor_docker_image_tag', 'latest')}" + configs['pktvisor_docker_image'] = f"orbcommunity/pktvisor:{configs.get('pktvisor_docker_image_tag', 'latest')}" try: client.images.get(configs['pktvisor_docker_image']) except ImageNotFound: From 7880cd567e0db89ffd53e477d0fb5afbeec5c07e Mon Sep 17 00:00:00 2001 From: manrodrigues Date: Wed, 5 Apr 2023 12:18:08 -0300 Subject: [PATCH 03/10] Update TerminalEmulatorRequired.txt --- appimage/pktvisor/TerminalEmulatorRequired.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appimage/pktvisor/TerminalEmulatorRequired.txt b/appimage/pktvisor/TerminalEmulatorRequired.txt index 3aab6fbd3..960af1977 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/orbcommunity/pktvisor for more details. \ No newline at end of file +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. From 282d5e836360886eda5da86ae17acb4cf804aa60 Mon Sep 17 00:00:00 2001 From: manrodrigues Date: Wed, 5 Apr 2023 12:22:22 -0300 Subject: [PATCH 04/10] Update index.html --- docs/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.html b/docs/index.html index ccdf93c0d..c42347e08 100644 --- a/docs/index.html +++ b/docs/index.html @@ -180,8 +180,8 @@

pktvisor

pktvisor summarizes data streams in real time and provides a clean, time-windowed HTTP interface and command line UI to the results
-
More information: https://helloreverb.com
-
Contact Info: orbcommunity@ns1.com
+
More information: https://orb.community/
+
Contact Info: info@netboxlabs.com
Version: 3.0.0-oas3
Apache 2.0
From 4df4e9ac028538389dfa6b5f8440b5a3b73f0b22 Mon Sep 17 00:00:00 2001 From: manrodrigues Date: Wed, 5 Apr 2023 12:23:25 -0300 Subject: [PATCH 05/10] Update pktvisor-3.0.0-oas3-swagger.yaml --- docs/pktvisor-3.0.0-oas3-swagger.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pktvisor-3.0.0-oas3-swagger.yaml b/docs/pktvisor-3.0.0-oas3-swagger.yaml index 5137ab9bb..8b7d2c9d5 100644 --- a/docs/pktvisor-3.0.0-oas3-swagger.yaml +++ b/docs/pktvisor-3.0.0-oas3-swagger.yaml @@ -4,7 +4,7 @@ info: version: 3.0.0-oas3 title: pktvisor contact: - email: orbcommunity@ns1.com + email: info@netboxlabs license: name: Apache 2.0 url: 'http://www.apache.org/licenses/LICENSE-2.0.html' @@ -205,4 +205,4 @@ components: in: type: object out: - type: object \ No newline at end of file + type: object From 59edc94738aaf7dc39cc0442b3bc6672e02e7d81 Mon Sep 17 00:00:00 2001 From: "Everton H. Taques" <97463920+etaques@users.noreply.github.com> Date: Wed, 5 Apr 2023 12:58:54 -0300 Subject: [PATCH 06/10] fix image duplicated --- .github/workflows/debug_build.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/debug_build.yml b/.github/workflows/debug_build.yml index 5df2f4475..e8320436e 100644 --- a/.github/workflows/debug_build.yml +++ b/.github/workflows/debug_build.yml @@ -191,8 +191,7 @@ jobs: - name: Build, push debug image + crashhandler env: IMAGE_NAME: orbcommunity/pktvisor - IMAGE_NAME1: orbcommunity/pktvisor run: | - docker build . --file docker/Dockerfile.crashhandler --tag ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} --tag ${{ env.IMAGE_NAME1 }}:${{ env.REF_TAG }} + docker build . --file docker/Dockerfile.crashhandler --tag ${{ env.IMAGE_NAME }}:${{ env.REF_TAG }} docker push -a ${{ env.IMAGE_NAME }} - docker push -a ${{ env.IMAGE_NAME1 }} + From fb7562e8db0063c562e7fa0c8a9c13e55c53963e Mon Sep 17 00:00:00 2001 From: manrodrigues Date: Wed, 5 Apr 2023 13:20:12 -0300 Subject: [PATCH 07/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ed1deb90..bc366cc44 100644 --- a/README.md +++ b/README.md @@ -531,7 +531,7 @@ Also see [getorb.io](https://getorb.io) for information on connecting pktvisor a ### REST API -REST API documentation is available in [OpenAPI Format](https://app.swaggerhub.com/apis/orbcommunity/pktvisor/3.0.0-oas3) +REST API documentation is available in [OpenAPI Format](https://app.swaggerhub.com/apis/orb-community/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 From b921308b8d262aba1bf34bb395ab8ddae02b07ef Mon Sep 17 00:00:00 2001 From: "Everton H. Taques" <97463920+etaques@users.noreply.github.com> Date: Wed, 5 Apr 2023 13:32:38 -0300 Subject: [PATCH 08/10] not using jfrog more --- .github/workflows/code-ql.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/code-ql.yml b/.github/workflows/code-ql.yml index a11a917d2..acd967a46 100644 --- a/.github/workflows/code-ql.yml +++ b/.github/workflows/code-ql.yml @@ -68,7 +68,6 @@ jobs: # create conan config CONAN_V2_MODE=1 conan config init conan config set general.revisions_enabled=1 - conan remote add orbcommunity https://orbcommunity.jfrog.io/artifactory/api/conan/orbcommunity-conan # add custom compiler settings for libc python3 -c 'import yaml; p = "${{env.CONAN_USER_HOME}}/.conan/settings.yml"; d = yaml.safe_load(open(p)); d["compiler"]["gcc"]["libc"] = ["None", "glibc", "musl"]; yaml.safe_dump(d, open(p, "w"))' # Create Conan host profile From d3b9c7255dad68e0e647d654995d55a5dcd995bb Mon Sep 17 00:00:00 2001 From: "Everton H. Taques" <97463920+etaques@users.noreply.github.com> Date: Wed, 5 Apr 2023 13:35:02 -0300 Subject: [PATCH 09/10] test --- .github/workflows/code-ql.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/code-ql.yml b/.github/workflows/code-ql.yml index acd967a46..87391ab46 100644 --- a/.github/workflows/code-ql.yml +++ b/.github/workflows/code-ql.yml @@ -2,11 +2,9 @@ name: "CodeQL" on: - #push: - # branches: [ "develop" ] - #pull_request: - # The branches below must be a subset of the branches above - # branches: [ "develop" ] + push: + branches: [ develop, ns1labs_orbcommunity ] + schedule: #run 5 minutes after midnight daily - cron: '5 0 * * *' From 151be384446760e6e76a8fe7b0232470822b0663 Mon Sep 17 00:00:00 2001 From: "Everton H. Taques" <97463920+etaques@users.noreply.github.com> Date: Wed, 5 Apr 2023 13:41:21 -0300 Subject: [PATCH 10/10] remove test --- .github/workflows/code-ql.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/code-ql.yml b/.github/workflows/code-ql.yml index 87391ab46..460cefa3c 100644 --- a/.github/workflows/code-ql.yml +++ b/.github/workflows/code-ql.yml @@ -2,8 +2,6 @@ name: "CodeQL" on: - push: - branches: [ develop, ns1labs_orbcommunity ] schedule: #run 5 minutes after midnight daily