Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

uffizzi dev describe #343

Open
gadkins opened this issue Sep 25, 2023 · 3 comments
Open

uffizzi dev describe #343

gadkins opened this issue Sep 25, 2023 · 3 comments
Assignees

Comments

@gadkins
Copy link
Member

gadkins commented Sep 25, 2023

Summary

  • Display information about the specified dev environment.
  • For this iteration, just display the same information as uffizzi cluster describe

Usage

uffizzi dev describe [NAME]

Output

Dump the following output to stdout:

- NAME: test-1
- STATUS: deployed
- CREATED: Mon Sep 25 19:19:39 2023
- HOST: test-1-c806.uclusters.app.uffizzi.com

Note: We should rename the field URL to HOST as shown above.

@gadkins
Copy link
Member Author

gadkins commented Sep 25, 2023

Help page (uffizzi dev describe -h)

$ uffizzi dev describe -h
uffizzi-dev-describe - show metadata for a dev environment
================================================================

## SYNOPSIS
    uffizzi dev describe [NAME] [UFFIZZI_WIDE_FLAG ...]

## DESCRIPTION
    Shows metadata for a dev environment given a valid NAME

    This command can fail for the following reasons:
        - The dev environment specified does not exist.
        - The dev environment specified belongs to a different project.

    For more information on Uffizzi clusters, see:
    https://docs.uffizzi.com/references/cli/

## POSITIONAL ARGUMENTS
    [NAME]
        NAME for the dev environment you want to describe.

## UFFIZZI WIDE FLAGS
    These flags are available to all commands: --project 
    Run `uffizzi -h` for details.

## FLAGS
    --output=pretty-json
    --output=json
        Use this option for formatting output.

## EXAMPLES
    The following command prints metadata for the dev 
    environment with NAME my-env:

        $ uffizzi dev describe my-env

@moklidia
Copy link
Collaborator

moklidia commented Oct 2, 2023

As the user is only able to create one dev environment, remove the NAME argument

@zipofar zipofar self-assigned this Oct 6, 2023
@zipofar zipofar linked a pull request Oct 10, 2023 that will close this issue
@zipofar
Copy link
Contributor

zipofar commented Oct 10, 2023

Updated OUTPUT:

- NAME: test-1
- STATUS: deployed
- CREATED: Mon Sep 25 19:19:39 2023
- HOST: test-1-c806.uclusters.app.uffizzi.com
- CONFIG_PATH: /some/project/skaffold.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

3 participants