The environment command manages deployment environments, allowing you to organize and isolate infrastructure resources by environment type (development, staging, production, etc.).
Synopsis mesheryctl environment [subcommand] [flags]
Subcommands
create - Create a new environmentdelete - Delete an environmentlist - List all environmentsview - View environment details
create Create a new environment in an organization.
Usage mesheryctl environment create [flags]
Flags Organization ID to create environment in
Examples Create Environment
Create Staging Environment
# Create development environment mesheryctl environment create --orgID org-123 --name development --description "Dev environment" # Create production environment mesheryctl environment create --orgID org-123 --name production --description "Production infrastructure"
Sample Output Creating environment... Environment created successfully ID: env-7e8b42f9-0e5c-4b7a-8f3d-9c2e1a6b5d4c Name: development Organization: org-123 Description: Dev environment
delete Delete an environment from an organization.
Usage mesheryctl environment delete [environment-id] [flags]
Examples # Delete environment by ID mesheryctl environment delete env-7e8b42f9-0e5c-4b7a-8f3d-9c2e1a6b5d4c
Sample Output Deleting environment development... Environment deleted successfully
Deleting an environment does not delete the resources deployed in it. It only removes the environment metadata from Meshery.
list List all environments in an organization.
Usage mesheryctl environment list [flags]
Flags Organization ID to list environments from
Page number for pagination
Number of environments per page
Examples List Environments
Pagination
# List all environments in organization mesheryctl environment list --orgID org-123
Sample Output NAME OWNER ORGANIZATION CREATED development user@example.com org-123 2024-03-01 10:30:00 staging user@example.com org-123 2024-03-02 14:22:00 production admin@example.com org-123 2024-03-03 09:15:00 Total: 3 environments
view View detailed information about an environment.
Usage mesheryctl environment view [environment-id] [flags]
Flags Output format: yaml, json. Short form: -o
Examples # View environment in YAML mesheryctl environment view env-123 --orgID org-123 # View in JSON format mesheryctl environment view env-123 --orgID org-123 -o json
Sample Output id : env-7e8b42f9-0e5c-4b7a-8f3d-9c2e1a6b5d4c name : development description : Dev environment owner : user@example.com organizationID : org-123 createdAt : 2024-03-01T10:30:00Z updatedAt : 2024-03-10T09:30:00Z connections : - local-k8s - dev-cluster designs : - bookinfo-app - nginx-deployment
Use Cases Multi-Environment Setup # Create standard environments mesheryctl environment create --orgID org-123 --name development --description "Development" mesheryctl environment create --orgID org-123 --name staging --description "Staging" mesheryctl environment create --orgID org-123 --name production --description "Production" # List all environments mesheryctl environment list --orgID org-123
Environment Lifecycle # Create temporary test environment mesheryctl environment create --orgID org-123 --name feature-test --description "Feature testing" # Use environment for testing # ... deploy and test resources ... # Delete when done mesheryctl environment delete env-feature-test-id
View Environment Details # List environments mesheryctl environment list --orgID org-123 # View specific environment mesheryctl environment view env-123 --orgID org-123
Environment Properties Each environment includes:
ID - Unique identifierName - Environment name (development, staging, production, etc.)Description - Environment purpose and detailsOwner - User who created the environmentOrganization - Parent organizationConnections - Associated cluster connectionsDesigns - Deployed designs in the environmentCreated/Updated - Timestamps
Environment Types Common environment types:
development - For active development and feature workstaging - For pre-production testing and validationproduction - For live production workloadstesting - For automated testing and CI/CDqa - For quality assurance testingdemo - For demonstrations and training
Best Practices Naming Conventions # Use descriptive names mesheryctl environment create --orgID org-123 --name prod-us-east mesheryctl environment create --orgID org-123 --name dev-feature-auth # Include region or purpose in name mesheryctl environment create --orgID org-123 --name staging-eu-west
Environment Isolation
Use separate environments for different lifecycle stages
Map environments to Kubernetes namespaces or clusters
Apply environment-specific policies and configurations
Control access via organization roles
Resource Management
Tag resources with environment labels
Track deployed designs per environment
Monitor environment-specific metrics
Maintain environment documentation
Workflow
Create Organization - Set up organization structureCreate Environments - Define environment hierarchyAdd Connections - Associate cluster connectionsDeploy Designs - Deploy infrastructure to environmentsMonitor - Track environment health and resourcesClean Up - Remove unused environments
Integration with Other Commands With Connections # Create environment mesheryctl environment create --orgID org-123 --name staging # Create connection for environment mesheryctl connection create --type eks --name staging-cluster # Associate connection with environment (via UI or API)
With Designs # Deploy design to specific environment mesheryctl design apply -f design.yaml # (Select environment during deployment)
With Workspaces # Create workspace for environment mesheryctl workspace create --orgID org-123 --name dev-workspace # Associate environment with workspace
Troubleshooting Environment Creation Fails # Verify organization ID mesheryctl org list # Check permissions # Ensure you have permission to create environments in the organization
Cannot List Environments # Verify organization ID is correct mesheryctl environment list --orgID org-123 # Check authentication mesheryctl system login
Environment Not Found # List all environments to find correct ID mesheryctl environment list --orgID org-123 # Verify environment ID format # IDs should be UUIDs
Delete Fails # Ensure environment is not in use # Check for deployed designs or active connections # View environment details first mesheryctl environment view env-123 --orgID org-123
See Also