xmidt-agent

module
v0.5.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2024 License: Apache-2.0

README

xmidt-agent

The client agent for the Xmidt service.

Build Status codecov.io Go Report Card Apache V2 License GitHub Release

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Contributing

Refer to CONTRIBUTING.md.

Run xmidt-agent simulator as a docker container

  1. build xmidt-agent for alpine cd cmd/xmidt-agent env GOOS=linux GOARCH=arm64 go build .
  2. mv cmd/xmidt-agent/xmdidt-agent binary to the root directory
  3. from the root directory, build the docker container docker build -t xmdit-agent .
  4. run the container docker run xmdit-agent --dev
  5. Note that you will see a connection error unless a websocket server is running at the default url specified by websocket -> back_up_url in cmd/xmidt-agent/default-config.yaml.
  6. To override the default configuration, update the below config file OR bind a config file to target "/etc/xmidt-agent/xmidt-agent.yaml" at runtime: .release/docker/config/config.yml
  7. If using TLS, the Dockerfile expects the certificate and key files to be ".release/docker/certs" at build time. Otherwise bind the directory at runtime.

Directories

Path Synopsis
cmd
xmidt-agent
SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC SPDX-License-Identifier: Apache-2.0
SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC SPDX-License-Identifier: Apache-2.0
internal
fs
net
nhooyr.io/websocket
Package websocket implements the RFC 6455 WebSocket protocol.
Package websocket implements the RFC 6455 WebSocket protocol.
nhooyr.io/websocket/internal/test
Package test contains subpackages only used in tests.
Package test contains subpackages only used in tests.
nhooyr.io/websocket/internal/wsjs
Package wsjs implements typed access to the browser javascript WebSocket API.
Package wsjs implements typed access to the browser javascript WebSocket API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL