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

Doc update git-data - zarf tools get-admin-password has been replaced #1934

Closed
cmwylie19 opened this issue Jul 31, 2023 · 1 comment · Fixed by #1935
Closed

Doc update git-data - zarf tools get-admin-password has been replaced #1934

cmwylie19 opened this issue Jul 31, 2023 · 1 comment · Fixed by #1935
Assignees

Comments

@cmwylie19
Copy link
Contributor

Environment

Device and OS:
App version:
Kubernetes distro being used:
Other:

Steps to reproduce

  1. https://docs.zarf.dev/examples/git-data/
zarf tools get-admin-password
NOTE  Using config file /Users/cmwylie19/zarf/zarf-config.toml
Collection of additional tools to make airgap easier

Usage:
  zarf tools [command]

Aliases:
  tools, t

Available Commands:
  archiver         Compresses/Decompresses generic archives, including Zarf packages
  clear-cache      Clears the configured git and image cache directory
  download-init    Downloads the init package for the current Zarf version into the specified directory
  gen-key          Generates a cosign public/private keypair that can be used to sign packages
  gen-pki          Generates a Certificate Authority and PKI chain of trust for the given host
  get-creds        Displays a Table of credentials for deployed components. Pass a component name to get a single credential
  kubectl          Kubectl command. See https://kubernetes.io/docs/reference/kubectl/overview/ for more information.
  monitor          Launches a terminal UI to monitor the connected cluster using K9s.
  registry         Tools for working with container registries using go-containertools
  sbom             Generates a Software Bill of Materials (SBOM) for the given package
  wait-for         Waits for a given Kubernetes resource to be ready

Flags:
  -h, --help   help for tools

Global Flags:
  -a, --architecture string   Architecture for OCI images and Zarf packages
      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
      --no-log-file           Disable log file creation
      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
      --tmpdir string         Specify the temporary directory to use for intermediate files
      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")

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

Expected result

zarf tools get-creds Git

output

 NOTE  Using config file /Users/cmwylie19/zarf/zarf-config.toml
  ✔  Waiting for cluster connection (30s timeout)                                                

 NOTE  Git Server push password (username: zarf-git-user):
ORKmToG2Usr!1WG6uNG0NGFd

Actual Result

Visual Proof (screenshots, videos, text, etc)

Severity/Priority

Additional Context

Add any other context or screenshots about the technical debt here.

@cmwylie19
Copy link
Contributor Author

cmwylie19 commented Jul 31, 2023

also the podinfo example has been removed from the zarf.yaml, im adding it back in

zarf tools kubectl apply -k http://zarf-git-user:$(zarf tools get-creds Git)@localhost:54824/zarf-git-user/podinfo-1646971829/kustomize

 NOTE  Using config file /Users/cmwylie19/zarf/zarf-config.toml
  ✔  Waiting for cluster connection (30s timeout)                               

 NOTE  Git Server push password (username: zarf-git-user):
service/podinfo created
deployment.apps/podinfo created
horizontalpodautoscaler.autoscaling/podinfo created

Racer159 added a commit that referenced this issue Aug 2, 2023
## Description
On the git-data [example](https://docs.zarf.dev/examples/git-data/)
command `zarf tools get-admin-password` does not exist anymore. Replace
this with `zarf tools get-creds Git` which will give the desired
password

## Related Issue

Fixes #1934 
<!-- or -->
Relates to #

## Type of change

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: razzle <harry@razzle.cloud>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant