Akamas Docs
3.6
3.6
  • Home
  • Getting started
    • Introduction
    • Insights for Kubernetes
    • Free Trial
    • Licensing
    • Deployment
      • Cloud Hosting
    • Security
    • Maintenance & Support (M&S) Services
      • Customer Support Services
      • Support levels for Customer Support Services
      • Support levels for software versions
      • Support levels with Akamas
  • Installing
    • Architecture
    • Docker compose installation
      • Prerequisites
        • Hardware Requirements
        • Software Requirements
        • Network requirements
      • Install Akamas dependencies
      • Install the Akamas Server
        • Online installation mode
          • Online installation behind a Proxy server
        • Offline installation mode
        • Changing UI Ports
        • Setup HTTPS configuration
      • Troubleshoot Docker installation issues
    • Kubernetes installation
      • Prerequisites
        • Cluster Requirements
        • Software Requirements
      • Install Akamas
        • Online Installation
        • Offline Installation - Private registry
      • Installing on OpenShift
      • Accessing Akamas
      • Useful commands
      • Selecting Cluster Nodes
    • Install the CLI
      • Setup the CLI
      • Initialize the CLI
      • Change CLI configuration
      • Use a proxy server
    • Verify the installation
    • Installing the toolbox
    • Install the license
    • Manage anonymous data collection
  • Managing Akamas
    • Akamas logs
    • Audit logs
    • Upgrade Akamas
      • Docker compose
      • Kubernetes
    • Monitor Akamas status
    • Backup & Recover of the Akamas Server
    • Users management
      • Accessing Keycloak admin console
      • Configure an external identity provider
        • Azure Active Directory
        • Google
      • Limit users sessions
        • Local users
        • Identity provider users
    • Collecting support information
  • Using
    • System
    • Telemetry
    • Workflow
    • Study
      • Offline Study
      • Live Study
        • Analyzing results of live optimization studies
      • Windowing
      • Parameters and constraints
  • Optimization Guides
    • Optimize application costs and resource efficiency
      • Kubernetes microservices
        • Optimize cost of a Kubernetes deployment subject to Horizontal Pod Autoscaler
        • Optimize cost of a Kubernetes microservice while preserving SLOs in production
        • Optimize cost of a Java microservice on Kubernetes while preserving SLOs in production
      • Application runtime
        • Optimizing a sample Java OpenJDK application
        • Optimizing cost of a Node.js application with performance tests
        • Optimizing cost of a Golang application with performance tests
        • Optimizing cost of a .NET application with performance tests
      • Applications running on cloud instances
        • Optimizing a sample application running on AWS
      • Spark applications
        • Optimizing a Spark application
    • Optimize application performance and reliability
      • Kubernetes microservices
        • Optimizing cost of a Kubernetes microservice while preserving SLOs in production
        • Optimizing cost of a Java microservice on Kubernetes while preserving SLOs in production
  • Integrating
    • Integrating Telemetry Providers
      • CSV provider
        • Install CSV provider
        • Create CSV telemetry instances
      • Dynatrace provider
        • Install Dynatrace provider
        • Create Dynatrace telemetry instances
          • Import Key Requests
      • Prometheus provider
        • Install Prometheus provider
        • Create Prometheus telemetry instances
        • CloudWatch Exporter
        • OracleDB Exporter
      • Spark History Server provider
        • Install Spark History Server provider
        • Create Spark History Server telemetry instances
      • NeoLoadWeb provider
        • Install NeoLoadWeb telemetry provider
        • Create NeoLoadWeb telemetry instances
      • LoadRunner Professional provider
        • Install LoadRunner Professional provider
        • Create LoadRunner Professional telemetry instances
      • LoadRunner Enterprise provider
        • Install LoadRunner Enterprise provider
        • Create LoadRunner Enterprise telemetry instances
      • AWS provider
        • Install AWS provider
        • Create AWS telemetry instances
    • Integrating Configuration Management
    • Integrating with pipelines
    • Integrating Load Testing
      • Integrating NeoLoad
      • Integrating LoadRunner Professional
      • Integrating LoadRunner Enterprise
  • Reference
    • Glossary
      • System
      • Component
      • Metric
      • Parameter
      • Component Type
      • Workflow
      • Telemetry Provider
      • Telemetry Instance
      • Optimization Pack
      • Goals & Constraints
      • KPI
      • Optimization Study
      • Workspace
      • Safety Policies
    • Construct templates
      • System template
      • Component template
      • Parameter template
      • Metric template
      • Component Types template
      • Telemetry Provider template
      • Telemetry Instance template
      • Workflows template
      • Study template
        • Goal & Constraints
        • Windowing policy
          • Trim windowing
          • Stability windowing
        • Parameter selection
        • Metric selection
        • Workload selection
        • KPIs
        • Steps
          • Baseline step
          • Bootstrap step
          • Preset step
          • Optimize step
        • Parameter rendering
        • Optimizer Options
    • Workflow Operators
      • General operator arguments
      • Executor Operator
      • FileConfigurator Operator
      • LinuxConfigurator Operator
      • WindowsExecutor Operator
      • WindowsFileConfigurator Operator
      • Sleep Operator
      • OracleExecutor Operator
      • OracleConfigurator Operator
      • SparkSSHSubmit Operator
      • SparkSubmit Operator
      • SparkLivy Operator
      • NeoLoadWeb Operator
      • LoadRunner Operator
      • LoadRunnerEnteprise Operator
    • Telemetry metric mapping
      • Dynatrace metrics mapping
      • Prometheus metrics mapping
      • NeoLoadWeb metrics mapping
      • Spark History Server metrics mapping
      • LoadRunner metrics mapping
    • Optimization Packs
      • Linux optimization pack
        • Amazon Linux
        • Amazon Linux 2
        • Amazon Linux 2022
        • CentOS 7
        • CentOS 8
        • RHEL 7
        • RHEL 8
        • Ubuntu 16.04
        • Ubuntu 18.04
        • Ubuntu 20.04
      • DotNet optimization pack
        • DotNet Core 3.1
      • Java OpenJDK optimization pack
        • Java OpenJDK 8
        • Java OpenJDK 11
        • Java OpenJDK 17
      • OpenJ9 optimization pack
        • IBM J9 VM 6
        • IBM J9 VM 8
        • Eclipse Open J9 11
      • Node JS optimization pack
        • Node JS 18
      • GO optimization pack
        • GO 1
      • Web Application optimization pack
        • Web Application
      • Docker optimization pack
        • Container
      • Kubernetes optimization pack
        • Horizontal Pod Autoscaler v1
        • Horizontal Pod Autoscaler v2
        • Kubernetes Pod
        • Kubernetes Container
        • Kubernetes Workload
        • Kubernetes Namespace
        • Kubernetes Cluster
      • WebSphere optimization pack
        • WebSphere 8.5
        • WebSphere Liberty ND
      • AWS optimization pack
        • EC2
        • Lambda
      • PostgreSQL optimization pack
        • PostgreSQL 11
        • PostgreSQL 12
      • Cassandra optimization pack
        • Cassandra
      • MySQL Database optimization pack
        • MySQL 8.0
      • Oracle Database optimization pack
        • Oracle Database 12c
        • Oracle Database 18c
        • Oracle Database 19c
        • RDS Oracle Database 11g
        • RDS Oracle Database 12c
      • MongoDB optimization pack
        • MongoDB 4
        • MongoDB 5
      • Elasticsearch optimization pack
        • Elasticsearch 6
      • Spark optimization pack
        • Spark Application 2.2.0
        • Spark Application 2.3.0
        • Spark Application 2.4.0
    • Command Line commands
      • Administration commands
      • User and Workspace management commands
      • Authentication commands
      • Resource management commands
      • Optimizer options commands
    • Release Notes
  • Knowledge Base
    • Performing load testing to support optimization activities
    • Creating custom optimization packs
    • Setting up a Konakart environment for testing Akamas
    • Modeling a sample Java-based e-commerce application (Konakart)
    • Optimizing a web application
    • Optimizing a sample Java OpenJ9 application
    • Optimizing a sample Linux system
    • Optimizing a MongoDB server instance
    • Optimizing a Kubernetes application
    • Leveraging Ansible to automate AWS instance management
    • Guidelines for optimizing AWS EC2 instances
    • Optimizing an Oracle Database server instance
    • Optimizing an Oracle Database for an e-commerce service
    • Guidelines for optimizing Oracle RDS
    • Optimizing a MySQL server database running Sysbench
    • Optimizing a MySQL server database running OLTPBench
    • Optimizing a live full-stack deployment (K8s + JVM)
    • Setup Instana integration
    • Setup Locust telemetry via CSV
    • Setup AppDynamics integration
Powered by GitBook
On this page
  • Create workspace
  • Update workspace
  • Delete workspace
  • List users
  • Create user
  • Describe user
  • Update user
  • Update password
  • Delete user

Was this helpful?

Export as PDF
  1. Reference
  2. Command Line commands

User and Workspace management commands

Last updated 10 months ago

Was this helpful?

This page describes all commands that allow users and workspaces to be managed with their options (see also available for all commands).

Command
Description

create a workspace

update a workspace

delete a workspace

list users

create a user

describe a user

update user profile

update user password

delete a user

Notice: an Akamas workspace (user) is an Akamas resource (see list of ) so you can also refer to .

Create workspace

The create workspace command allows defining a new workspace:

akamas create workspace NAME

The following snippet shows an example:

akamas create  workspace 'New Workspace'

After the workspace has been created you can add users to the workspace with the following command:

akamas update user <user> -w 'New Workspace' W

See Update user section for further details

Update workspace

The update workspace command allows updating the workspace name:

akamas update workspace [OPTIONS] IDENTIFIER

with the following options:

Option
Required
Description

--name TEXT

yes

New workspace name

The following snippet shows an example:

akamas update workspace 'New Workspace' --name 'New Name'

Delete workspace

The delete workspace command allows deleting a workspace:

akamas delete workspace [OPTIONS] IDENTIFIER

with the following options:

Option
Required
Description

-y

no

Show this message and exit

The following snippet shows an example:

akamas delete workspace 'New Workspace'

List users

The list users command returns the list of the available users.

akamas list users

The following snippet shows an example:

$ akamas list users

                 Id                    Username   First Name   Last Name   Workspaces       User Type
=======================================================================================================
66778cc3-4b01-4f3e-8921-c279600c8e07   akamas     -            -           -              Administrator
ae8bfe02-e32d-480b-92ed-30a8d8e835ef   newuser    new          user        Default W      User
                                                                           Workspace1 R

Create user

The create user command allows defining a new user and assigning it to one or more workspaces.

akamas create user [OPTIONS]

with the following options

Option
Required
Description

-u, --username TEXT

yes

Username

-p, --password TEXT

yes

Password

--first-name TEXT

no

User first name

--last-name TEXT

no

User last name

--email TEXT

no

Valid email

-w, --add-to-workspace TEXT

no

Add the user to the specified workspace with the specified role (R|W) (e.g., --add-to-workspace WORKSPACE_A R). The option can be specified multiple times to add more workspaces.

--admin

no

Specify if you want to give Administration privileges to the user

The default policy requires the password to satisfy the following rules:

  • Include one or more uppercase characters (A-Z)

  • Include one or more special characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/)

The username and password can be either provided interactively or as command arguments.

The following snippet shows the process of creating a new user interactively:

$ akamas create user

Username: newuser
Password:
Repeat for confirmation:
User first name: John
User last name: Doe
Email: john.doe@akamas.io

The same action can be performed using the command options:

$ akamas create user -u newuser -p P455w0rd

Describe user

The describe user command returns the details of a valid user matching the provided username or ID:

akamas describe user IDENTIFIER

Notice: users without administrative privileges can only describe their profiles, while administrators can inspect any profile.

The following snippet shows an example:

akamas describe user newuser

# Id         | a81fd6e5-aedc-4b74-b6d2-40650441935b
# Username   | newuser
# First Name | new
# Last Name  | user
# Email      | newuser@akamas.io
# Workspaces | - Default R
#            | - Workspace1 W
# User Type  | User

Update user

The update user command allows updating the user profile attributes for the user matching the username or ID:

akamas update user [OPTIONS] IDENTIFIER

with the following options:

Option
Required
Description

--first-name TEXT

no

User first name

--last-name TEXT

no

User last name

--email TEXT

no

Valid email

-w, --add-to-workspace TEXT

no

Add the user to the specified workspace with the specified role (R|W) (e.g., --add-to-workspace WORKSPACE_A R). The option can be specified multiple times to add more workspaces.

-r, --remove-from-workspace TEXT

no

Remove the user from the specified workspace

--admin

no

Specify if you want to give Administration privileges to the user

--no-admin

no

Specify if you want to remove Administration privileges to the user

For single sign-on users is possible to update only the workspaces and the administration privilege. It is not possible to modify the profile info.

The following snippet shows an example of updating the email of a user:

akamas update user --email 'new.email@akamas.io' newuser

This command is also used to grant or revoke access to workspaces and administrative privileges to users.

The following snippet shows an example of updating the user’s workspace access privileges, adding write privileges on Workspace 1, and revoking access on Default:

akamas update user -w 'Workspace 1' W -r Default newuser

Update password

The update password command updates the password for the user matching the username or ID:

akamas update password [OPTIONS] IDENTIFIER

with the following options:

Option
Required
Description

-p, --password TEXT

yes

New password

Users without administrative privileges can update only their own passwords, while administrators can perform this action on any profile.

Single sign-on users can't change their password using the Akamas CLI. They must manage their passwords through the configured external identity provider.

The default policy requires the password to satisfy the following rules:

  • Include one or more uppercase characters (A-Z)

  • Include one or more special characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/)

The password can be either provided interactively or as command arguments.

The following snippet shows the prompts to update the user password:

akamas update password newuser

# New password:
# Repeat for confirmation:

The same action can be performed using the command options:

akamas update password -p P455w0rd newuser

Delete user

The delete user command removes the user with the provided username or id:

akamas delete user IDENTIFIER

with the following options:

Option
Required
Description

-y

no

Automatic yes to prompts

The following snippet shows an example of deleting interactively a user:

akamas delete user newuser

Confirm deletion of newuser [y/N]: y

create workspace
update workspace
delete workspace
list users
create user
describe user
update user
update password
delete user
resource management commands
common options
Akamas resources