lfgcampos / axon-server-cli Goto Github PK

AxonServer CLI written in GO

License: Apache License 2.0

Go 100.00%

axon-server-cli's Introduction

Axon Server Command line interface

The intention of this repo is to have a similar cli as in axon-server-cli but written in go instead of java. This is more of a learning exercise of go language but should be as much usable as the official cli.

The Axon Server command line interface allows updating the Axon Server configuration through scripts or from a command line.

For the Axon Server Standard edition the only supported commands are:

metrics
users
register-user
delete-user

Axon Server Enterprise edition supports these additional commands:‌

The option -S with the url to the Axon Server is optional, if it is omitted it defaults to http://localhost:8024.

Access control

When running Axon Server with access control enabled, executing commands remotely requires an access token. This has to provided with the -t option. When you run a command on the Axon Server node itself, you don't have to provide a token.

For Axon Server Standard Edition, the token is specified in the axonserver.properties file (property name = axoniq.axonserver.token). The token needs to be supplied using the -t option in any of the commands.

Config

This specific cli accept a configuration file named axonserver-cli.yaml on the same directory or using -config flag to override it. In this file you can set default values for flags such as server and token.

Commands

This section describes some commands with examples supported by the command line interface. Mind that the list above is marking the ones which are already done. All commands have the -h option, which will show all the info you need to know including all the flags you can set.

For example:

axon-server-cli -h

This CLI is used to perform actions on AxonServer

Usage:
  axon-server-cli [command]

Available Commands:
  application commands related to applications
  context     commands related to contexts
  help        Help about any command
  user        Commands related to users

Flags:
      --config string   config file (default is axonserver-cli.yaml)
  -h, --help            help for axon-server-cli
  -S, --server string   URL of AxonServer (default "http://localhost:8024")
  -t, --token string    Authentication Token
  -v, --version         version for axon-server-cli

Use "axon-server-cli [command] --help" for more information about a command.

or axon-server-cli user -h

This is the command related to users

Usage:
  axon-server-cli user [command]

Aliases:
  user, u

Available Commands:
  delete      Remove a user
  list        list all the users
  register    Register a user

Flags:
  -h, --help   help for user

Global Flags:
      --config string   config file (default is axonserver-cli.yaml)
  -S, --server string   URL of AxonServer (default "http://localhost:8024")
  -t, --token string    Authentication Token

Use "axon-server-cli user [command] --help" for more information about a command.

or even deeper axon-server-cli user register -h

register a user to be used on axonserver

Usage:
  axon-server-cli user register [flags]

Aliases:
  register, r

Flags:
  -h, --help              help for register
  -p, --password string   user password
  -r, --roles strings     user roles
  -u, --username string   user username

Global Flags:
      --config string   config file (default is axonserver-cli.yaml)
  -S, --server string   URL of AxonServer (default "http://localhost:8024")
  -t, --token string    Authentication Token

Release process

Release is automatic triggered by a git tag using goreleaser. For do that, you have to create a new tag using git tag -a vx.y.z -m "my release message" and push it to the repo using git push origin master --tags.

axon-server-cli's People

Contributors

Stargazers

axon-server-cli's Issues

metrics command

https://docs.axoniq.io/reference-guide/operations-guide/setting-up-axon-server/command-line#metrics

Add Commands related to Replication Group

From AS/AF 4.4 onwards, a new concept of Replication Group was introduced.
We need to include commands related to that.

delete-context command

Implement register-application

RegisterApplication command as in RegisterApplication.java, and the doc

Introduce a verbose flag

For all operations we print things related to config, to the command, URLs, etc.
We should only print all that when the verbose flag is active.

register-context command

register-context command as in RegisterContext.java and doc.

"application register" is missing settoken option

From axonserver-cli:

/**
     * Defines the token for a new application. If this is omitted Axon Server will generate a token.
     */
    public static final Option SET_TOKEN = Option
            .builder("T")
            .longOpt("token")
            .hasArg()
            .desc("use this token for the app")
            .build();

[Refactor]: Use local command variables wherever possible.

Currently we have a lot of commands which use global package variables (declared at the top of the file).
Instead of doing that, we should get them via the cmd pointer, that's passed in to the Run function of the command, like so:

func deleteApplication(cmd *cobra.Command, args []string) {
  applicationName, _ := cmd.Flags().GetString("application")
  ...
}

Where, in the example, application is a flag command.

The JSON input (or output) would be:

$ ./axon-server-cli.exe application register -a myapp -d "My app from go cli" -r USE_CONTEXT@default
Using config file: C:\Users\Domin\IdeaProjects\axon-server-cli\axonserver-cli.yaml
2020/06/22 14:59:47 calling: http://localhost:8024/v1/applications
applicationJson:
{
  "name": "myapp",
  "description": "My app from go cli",
  "roles": [
    {
      "context": "default",
      "roles": [
        "USE_CONTEXT"
      ]
    }
  ]
}