appctl

Run apps, Not Clusters. Deploy apps on kubernetes in seconds, with no clusters required. Check for more information at https://platform9.com/appctl/

Read the docs: getting started with appctl

Purpose

appctl is a CLI that can be installed on Windows, MacOS and Linux, which connects to a Platform9 Managed Kubernetes Cluster running in AWS and enables users to deploy containerized applications in seconds.

A better way to run apps on K8s

appctl exposes the high value app orchestration capabilities available from Kubernetes and k-native, while hiding infrastructure complexity.
As a result, it is much faster to run apps while also running them more cost effectively in the cloud.

How `appctl` works

Pre-requisites

The CLI currently supports

Linux (64 bit)
Windows (64 bit)
MacOS (64 bit)

Installation

Downloading the CLI can be done from appctl website and from the command line.

To install from the command line of host machine, run the following commands to download the appctl CLI and give executable permission to use it.

Linux

curl -O https://pmkft-assets.s3.us-west-1.amazonaws.com/appctl/linux/appctl

chmod +x appctl

Mac

curl -O https://pmkft-assets.s3.us-west-1.amazonaws.com/appctl/macos/appctl

chmod +x appctl

Windows

curl -O https://pmkft-assets.s3.us-west-1.amazonaws.com/appctl/windows/appctl

After successfull download give the executable permission to appctl.

Once the CLI is successfully downloaded, run the Login command to authenticate to Platform9 and deploy applications.

Usage

Appctl Commands

Below are supported commands for appctl.

% ./appctl --help

CLI to deploy & manage apps in Platform9 environment.
Login first using $appctl login to use available commands.

Usage:
  appctl [command]

Available Commands:
  delete      Delete an existing app
  deploy      Deploy an app
  describe    Provide detailed app information in json format
  help        Help about any command
  list        Show all the running apps
  login       Login using Google account/Github account to use appctl
  version     Current version of appctl CLI being used

Flags:
  -h, --help      help for appctl

Use "appctl [command] --help" for more information about a command.

Login

To appctl, first login by running ./appctl login

% ./appctl login --help
Login using Google account/Github account to use appctl

Usage:
  appctl login [flags]

Examples:

  # Login using Google account/Github account to use appctl.
  appctl login
 

Flags:
  -h, --help   help for login

Example Login

% ./appctl login
Starting login process.
Device verification is required to continue login.
Your Device Confirmation code is: TX2KW-BNPW6%
- Waiting for login to complete in browser... 
✔ Successfully Logged in!!

Interactive login: The login command requires internet access and a web browser.

Appctl login is a two step process:

Device Verification: First verify where appctl is being run.
Login: Login using one of the supported federated identities (Google and Github).

When the command appctl login is run, a browser window will automatically open and prompt for the device confirmation code.

Confirm the device code displayed in the browser is identical to the code displayed by appctl, if it is correct click "Confirm" and the browser will redirected to _appctl log in _page.

Appctl device confirmation

Next, login using Google or Github account

Now on successful log in, appctl can be used to deploy applications.

Version

This command is used to get the current version of the CLI

% ./appctl version

appctl version: v1.1

Deploy

To deploy an app, run ./appctl deploy

The deploy command will deploy the specified container image using the provided name into Platform9 and automatically provision a fully qualified domain with a unique port to access the application.

% ./appctl deploy --help
Deploy an app

Usage:
  appctl deploy [flags]

Examples:

  # Deploy an app using app-name and container image (public registry path)
  # Assumes the container has a server that will listen on port 8080
  appctl deploy -n <appname> -i gcr.io/knative-samples/helloworld-go
  
  # Deploy an app using app-name and container image (private registry path)
  # Assumes the container has a server that will listen on port 8080
  appctl deploy -n <appname> -i <private registry image path> -u <container registry username> -P <container registry password>

  # Deploy an app using app-name and container image, and pass environment variables.
  # Assumes the container has a server that will listen on port 8080
  appctl deploy -n <appname> -i <image> -e key1=value1 -e key2=value2

  # Deploy an app using app-name, container image and pass environment variables and set port where application listens on.
  appctl deploy -n <appname> -i <image> -e key1=value1 -e key2=value2 -p <port>
  Ex: appctl deploy -n hello -i gcr.io/knative-samples/helloworld-go -e TARGET="appctler" -p 7893

# Deploy an app using app-name, container image and pass environment variables through a file and set port where application listens on.
  appctl deploy -n <appname> -i <image> -f <env-file-path> -p <port>
  Ex: appctl deploy -n hello -i gcr.io/knative-samples/helloworld-go -f /Users/user/variables.env -p 7893

  # Deploy an app using app-name, container image and pass environment variables through a file and pass through command line and set port where application listens on.
  appctl deploy -n <appname> -i <image> -f <env-file-path> -e key1=value1 -e key2=value2 -p <port>
  Ex: appctl deploy -n hello -i gcr.io/knative-samples/helloworld-go -f /Users/user/variables.env -e TARGET="appctler" -p 7893

Flags:
  -n, --app-name string   Name of the app to be deployed 
                          (lowercase alphanumeric characters, '-' or '.', must start with alphanumeric characters only)
  -e, --env stringArray   Environment variable to set, as key=value pair
  -h, --help              help for deploy
  -i, --image string      Container image of the app (public registry path)
  -P, --password string   Password of private container registry
  -p, --port string       The port where app server listens, set as '--port <port>'
  -u, --username string   Username of private container registry
  -f, --envPath string    Path to the environment variables file. 
                          (Values in the .env file should be formatted as a line separated Key=Value pair)

Example Deploy

% ./appctl deploy --app-name <name> --image <docker-image path>

Example:
/appctl deploy --app-name hello --image gcr.io/knative-samples/helloworld-go

Specifying Ports

If application server listens on a specific port, then specify that while deploying the app using --port flag.

% ./appctl deploy --app-name <name> --image <docker-image path> --port <port-value>

Example:
./appctl deploy --app-name hello --image gcr.io/knative-samples/helloworld-go --port 7893

Using Environment Variables

% ./appctl deploy --app-name <name> --image <docker-image path> --env key1=value1

Example:
./appctl deploy --app-name hello --image gcr.io/knative-samples/helloworld-go --env TARGET=appctler

Appctl supports multiple --env variables

% ./appctl deploy --app-name <name> --image <docker-image path> --env key1=value1 --env key2=value2

Appctl supports variables passed through a env file

% ./appctl deploy --app-name <name> --image <docker-image path> -f <env-file path>

Example:
./appctl deploy -n hello -i gcr.io/knative-samples/helloworld-go -f /Users/user/variables.env

A sample .env file would look like this: 
key1=value1
key2=value2

Appctl supports variables from both envFile and from command line

% ./appctl deploy --app-name <name> --image <docker-image path> -f <env-file path> --env key1=value1 --env key2=value2

Example:
./appctl deploy -n hello -i gcr.io/knative-samples/helloworld-go -f /Users/user/variables.env --env TARGET=appctler

List

To list all the running apps.

% ./appctl list --help 
Show all the running apps

Usage:
  appctl list [flags]

Examples:

  # Get all the apps deployed.
  appctl list
 

Flags:
  -h, --help   help for list

List Example

./appctl list
NAME           URL                                                IMAGE                                       READY  CREATIONTIME  REASON
cj-example  http://cj-example.cjones4s95lk.18.224.208.55.sslip.io  mcr.microsoft.com/dotnet/samples:aspnetapp  True  2021-12-21T21:52:58Z  nil

Describe

Describe can be used to display the applications current state.

% ./appctl describe --help
Provide detailed app information in json format

Usage:
  appctl describe [flags]

Examples:

  # Get detailed information about an app deployed through app-name in json format.
  appctl describe -n <appname>
 

Flags:
  -n, --app-name string   Name of app to be described
  -h, --help              help for describe

Describe Example

% ./appctl describe -n cj-example

Delete

% ./appctl delete --help
Delete an existing app

Usage:
  appctl delete [flags]

Examples:

  # Delete an app using app-name.
  appctl delete -n <appname>

  # Force delete an app using app-name and force flag.
  appctl delete -n <appname> -f
 

Flags:
  -n, --app-name string   Provide the name of app to be deleted
  -f, --force             To force delete an app
  -h, --help              help for delete

Delete Example

% ./appctl delete -n asp
Are you sure you want to delete app (y/n)? y
Successfully deleted the app: cj-example

Building `appctl` locally

Prerequisites

Building

Clone the repository, navigate to the cloned repository and download the dependencies using go mod download. Before building, ensure following environment variables are set either by following the instructions in .env.dev or by setting them as environment variables.

APPURL
DOMAIN
CLIENTID
GRANT_TYPE
APPCTL_SEGMENT_WRITE_KEY (optional)

# For setting up app-controller locally, visit: https://github.com/platform9/app-controller
APPURL := <YOUR_APP_CONTROLLER_URI>
# prebuilt binary uses auth0 for authentication
DOMAIN := <YOUR_AUTH0_APPLICATION_DOMAIN>
# auth0 client id
CLIENTID := <YOUR_AUTH0_CLIENT_ID>
# prebuilt binary uses grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code
GRANT_TYPE := <GRANT_TYPE>
# optional, used for telemetry
APPCTL_SEGMENT_WRITE_KEY := <YOUR_SEGMENT_WRITE_KEY>

appctl can be configured to work with a local or a hosted app-controller service installation. For more details on setting up app-controller locally, check the GitHub repository here.

Run the appropriate make target:

Linux
```
make build-linux64
```
Windows
```
make build-win64
```
MacOS
```
make build-mac
```

To generate all the binaries run the default target. The executables are placed in bin directory.

Name		Name	Last commit message	Last commit date
Latest commit History 136 Commits
.github		.github
cmd		cmd
images		images
pkg		pkg
.env.dev		.env.dev
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
appctl_setup		appctl_setup
build.bash		build.bash
git_utils.sh		git_utils.sh
go.mod		go.mod
go.sum		go.sum
main.go		main.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

appctl

Purpose

A better way to run apps on K8s

How `appctl` works

Pre-requisites

Installation

Linux

Mac

Windows

Usage

Appctl Commands

Login

Version

Deploy

List

Describe

Delete

Building `appctl` locally

Prerequisites

Building

About

Releases

Packages

Contributors 6

Languages

License

platform9/appctl

Folders and files

Latest commit

History

Repository files navigation

appctl

Purpose

A better way to run apps on K8s

How appctl works

Pre-requisites

Installation

Linux

Mac

Windows

Usage

Appctl Commands

Login

Version

Deploy

List

Describe

Delete

Building appctl locally

Prerequisites

Building

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 6

Languages

How `appctl` works

Building `appctl` locally

Packages