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

Create Tutorial for CLI #78

Open
lukaszo opened this issue Oct 11, 2021 · 1 comment
Open

Create Tutorial for CLI #78

lukaszo opened this issue Oct 11, 2021 · 1 comment
Labels
area/documentation Relates to all activities around documentation enhancement New feature or request

Comments

@lukaszo
Copy link
Contributor

lukaszo commented Oct 11, 2021

Description

Currently there is no dedicated tutorial for CLI usage. CLI usage is shown in multiple tutorials but there is no single place to direct.

We should have a tutorial which shows common CLI scenarios like:

  • Creating and watching actions
  • Using Type Instances, getting them from action
  • ...

Reason

To improve our docs quality.

@lukaszo lukaszo added the enhancement New feature or request label Oct 11, 2021
@mszostok
Copy link
Member

As we don't have the rollback yet, we can add also "tutorials" how to use capact to delete created resources. For example, for AWS Redis instance it will be:

git clone --depth 1 https:/umotif-public/terraform-aws-elasticache-redis.git
cd terraform-aws-elasticache-redis

capact typeinstance get <tfstate-ti-id> -ojson | jq -r '.[0].latestResourceVersion.spec.value.state' | base64 -d | sed -E 's/(.*"filename": ")(\/root)(.*)/\1~\3/g' > terraform.tfstate
capact typeinstance get <tfstate-ti-id> -ojson | jq -r '.[0].latestResourceVersion.spec.value.variables' | base64 -d > terraform.tfvars

terraform init
terraform destroy # region eu-west-1

@pkosiec pkosiec added the area/documentation Relates to all activities around documentation label Nov 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Relates to all activities around documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants