https://github.com/eclipse-iofog/iofogctl
iofogctl is a CLI for the installation, configuration, and operation of ioFog Edge Compute Networks (ECNs)
https://github.com/eclipse-iofog/iofogctl
Last synced: 6 months ago
JSON representation
iofogctl is a CLI for the installation, configuration, and operation of ioFog Edge Compute Networks (ECNs)
- Host: GitHub
- URL: https://github.com/eclipse-iofog/iofogctl
- Owner: eclipse-iofog
- License: epl-2.0
- Created: 2019-05-23T03:11:42.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-19T10:46:11.000Z (over 2 years ago)
- Last Synced: 2025-08-14T03:58:31.690Z (12 months ago)
- Language: Go
- Homepage: https://iofog.org
- Size: 18.7 MB
- Stars: 16
- Watchers: 7
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
`iofogctl` is a CLI for the installation, configuration, and operation of ioFog
[Edge Compute Networks](https://iofog.org/docs/2/getting-started/core-concepts.html) (ECNs).
It can be used to remotely manage multiple ECNs from a single host. It is built for ioFog users and DevOps engineers
wanting to manage ECNs. It is modelled on existing tools such as Terraform or kubectl that can be used to automate
infrastructure-as-code.
## Install
#### Mac
Mac users can use Homebrew:
```bash
brew tap eclipse-iofog/iofogctl
brew install iofogctl
```
#### Linux
The Debian package can be installed like so:
```bash
https://packagecloud.io/install/repositories/iofog/iofogctl/script.deb.sh | sudo bash
sudo apt install iofogctl
```
And similarly, the RPM package can be installed like so:
```
https://packagecloud.io/install/repositories/iofog/iofogctl/script.rpm.sh | sudo bash
sudo apt install iofogctl
```
## Usage
### Documentation
The best way to learn how to use `iofogctl` is through the [iofog.org](https://iofog.org/docs/2/getting-started/quick-start-local.html) learning resources.
#### Quick Start
See all iofogctl options
```
iofogctl --help
```
Current options include:
```
_ ____ __ __
(_)___ / __/___ ____ _____/ /_/ /
/ / __ \/ /_/ __ \/ __ `/ ___/ __/ /
/ / /_/ / __/ /_/ / /_/ / /__/ /_/ /
/_/\____/_/ \____/\__, /\___/\__/_/
/____/
Welcome to the cool new iofogctl Cli!
Use `iofogctl version` to display the current version.
Usage:
iofogctl [flags]
iofogctl [command]
Available Commands:
attach Attach an existing ioFog resource to Control Plane
configure Configure iofogctl or ioFog resources
connect Connect to an existing Control Plane
create Create a resource
delete Delete an existing ioFog resource
deploy Deploy Edge Compute Network components on existing infrastructure
describe Get detailed information of existing resources
detach Detach an existing ioFog resource from its ECN
disconnect Disconnect from an ioFog cluster
get Get information of existing resources
help Help about any command
legacy Execute commands using legacy CLI
logs Get log contents of deployed resource
move Move an existing resources inside the current Namespace
prune prune ioFog resources
rename Rename the iofog resources that are currently deployed
start Starts a resource
stop Stops a resource
version Get CLI application version
view Open ECN Viewer
Flags:
--detached Use/Show detached resources
-h, --help help for iofogctl
--http-verbose Toggle for displaying verbose output of API client
-n, --namespace string Namespace to execute respective command within (default "default")
-v, --verbose Toggle for displaying verbose output of iofogctl
Use "iofogctl [command] --help" for more information about a command.
```
### Autocomplete
If you are running BASH or ZSH, iofogctl comes with shell autocompletion scripts.
In order to generate those scripts, run:
```bash
iofogctl autocomplete bash
```
OR
```bash
iofogctl autocomplete zsh
```
Then follow the instructions output by the command.
Example:
```bash
iofogctl autocomplete bash
✔ $HOME/.iofog/completion.bash.sh generated
Run `source $HOME/.iofog/completion.bash.sh` to update your current session
Add `source $HOME/.iofog/completion.bash.sh` to your bash profile to have it saved
source $HOME/.iofog/completion.bash.sh
echo "$HOME/.iofog/completion.bash.sh" >> $HOME/.bash_profile
```
## Build from Source
This project uses go modules so it must be built from outside of your $GOPATH.
Go 1.16+ is a prerequisite. Install all other dependancies with:
```
make bootstrap
```
Make sure that your `$PATH` contains `$GOBIN`, otherwise `make build` will fail on the basis that command `rice` is not found.
See all `make` commands by running:
```
make
```
To build and install, go ahead and run:
```
make build install
iofogctl --help
```
iofogctl is installed in `/usr/local/bin`
## Running Tests
Run project unit tests:
```
make test
```
This will output a JUnit compatible file into `reports/TEST-iofogctl.xml` that can be imported in most CI systems.
## Embed assets
Run project build:
```
make build
```