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

CLOUDP-269965: [Atlas CLI] Documentation needs to be updated for some commands #3231

Merged
merged 6 commits into from
Oct 4, 2024

Conversation

andreaangiolillo
Copy link
Collaborator

@andreaangiolillo andreaangiolillo commented Sep 3, 2024

Proposed changes

Jira ticket: CLOUDP-269965

This PR updates the documentations for the commands listed in CLOUDP-269965

./bin/atlas accesslog list                                                                                                                            
Error: at least one of the flags in the group [clusterName hostname] is required
./bin/atlas accesslog list --help                                                                                                                         3s  1.22.5  16.18.0
To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role.

Usage:
  atlas accessLogs list {--clusterName clusterName | --hostname hostname} [flags]

Aliases:
  list, ls

Examples:
  # Return a JSON-formatted list of all authentication requests made against the cluster named Cluster0 for the project with ID 618d48e05277a606ed2496fe:
  atlas accesslogs list --output json --projectId 618d48e05277a606ed2496fe --clusterName Cluster0

  # Return a JSON-formatted list of all authentication requests made against the hostname named atlas-dqrlj4-shard-00-00.g1nxq.mongodb-dev.net for the project stored in the profile atlas-dev:
  atlas accesslogs list --hostname atlas-dqrlj4-shard-00-00.g1nxq.mongodb-dev.net --profile atlas-dev --output json


Flags:
      --authResult string    Authentication attempts that Atlas should return. When set to success, Atlas filters the log to return only successful authentication attempts. When set to fail, Atlas filters the log to return only failed authentication attempts.
      --clusterName string   Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api.
      --end string           Timestamp in the number of milliseconds that have elapsed, since the UNIX Epoch, for the last entry that Atlas returns from the database access logs.
  -h, --help                 help for list
      --hostname string      The fully qualified domain name (FQDN) of the target node that should receive the authentication attempt.
      --ip string            IP address that attempted to authenticate with the database. Atlas filters the returned logs to include documents with only this IP address.
      --nLog int             Maximum number of log lines to return.
  -o, --output string        Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
      --projectId string     Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
      --start string         Timestamp in the number of milliseconds that have elapsed, since the UNIX Epoch, for the first entry that Atlas returns from the database access logs.

Global Flags:
  -P, --profile string   Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

@andreaangiolillo andreaangiolillo marked this pull request as ready for review September 3, 2024 10:07
@github-actions github-actions bot added the need-doc-review Improvements or additions to documentation, will be reviewed by the docs team label Sep 3, 2024
Copy link
Contributor

github-actions bot commented Sep 3, 2024

APIx Bot :bowtie:: a message has been sent to Docs Slack channel 🚀.

@andreaangiolillo andreaangiolillo requested review from gssbzn, a team and tibulca September 3, 2024 10:11
davidhou17
davidhou17 previously approved these changes Sep 3, 2024
fmenezes
fmenezes previously approved these changes Sep 9, 2024
Copy link
Collaborator

@fmenezes fmenezes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jeroenvervaeke
Copy link
Collaborator

@andreaangiolillo, looks like this PR is stale. Do we still need these changes? Or can we close it?

@andreaangiolillo andreaangiolillo merged commit e4f4ced into master Oct 4, 2024
20 checks passed
@andreaangiolillo andreaangiolillo deleted the CLOUDP-269965 branch October 4, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need-doc-review Improvements or additions to documentation, will be reviewed by the docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants