Skip to content

Commit

Permalink
CLOUDP-250410: Remove MongoCLI references from AtlasCLI (#2969)
Browse files Browse the repository at this point in the history
  • Loading branch information
andreaangiolillo authored May 24, 2024
1 parent 98b65fb commit 1642457
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Flags are a way to modify the command, also may be called "options". Flags alway
- `--booleanFlag`: this flag represents a boolean and it sets the related variable to true when the flag is used, false otherwise. Example: `--force`
- `--flagName value1,value2,..,valueN`: you will also find flags that accept a list of values. This type of flag can be very useful to represent data structures as `--role roleName1@db,roleName2@db`, `--privilege [email protected],[email protected]`, or `--key field:type`.
As shown in the examples, the standard format used to represent data structures consists of splitting the first value with the second one by at sign `@` or colon `:`, and the second value with the third one by a full stop `.`.
We recommend using configuration files for complex data structures that require more than three values. For an example of configuration files, see [mongocli atlas cluster create](https://github.com/mongodb/mongodb-atlas-cli/blob/f2e6d661a3eb2cfcf9baab5f9e0b1c0f872b8c14/internal/cli/atlas/clusters/create.go#L235).
We recommend using configuration files for complex data structures that require more than three values. For an example of configuration files, see [atlas cluster create](https://github.com/mongodb/mongodb-atlas-cli/blob/f2e6d661a3eb2cfcf9baab5f9e0b1c0f872b8c14/internal/cli/atlas/clusters/create.go#L235).

#### Documentation Requirements

Expand Down
4 changes: 2 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Use the instructions bellow as a fallback.

## Package Managers

Package Managers are published after a stable release happens, in which binaries are stored in github releases and also uploaded to our download center (https://www.mongodb.com/try/download/atlascli and https://www.mongodb.com/try/download/mongocli).
Package Managers are published after a stable release happens, in which binaries are stored in github releases and also uploaded to our download center (https://www.mongodb.com/try/download/atlascli.

* [Chocolatey](http://chocolatey.org) release is triggered in https://github.com/mongodb-forks/chocolatey-packages/, the Github Action will trigger every weekday at 4pm (UTC) to check if there are any new releases in https://github.com/mongodb/mongodb-atlas-cli/releases/.

Expand Down Expand Up @@ -68,7 +68,7 @@ go version -m <path_to_atlasCLI_binary>
```

## Atlas CLI Docker image
We use `docker sbom` to generate the SBOM for the AtlasCLI docker image. You can generate the SBOM via the following command:
We use `docker sbom` to generate the SBOM for the Atlas CLI docker image. You can generate the SBOM via the following command:
```bash
docker sbom mongodb/atlas:latest
```
2 changes: 1 addition & 1 deletion docs/command/atlas-clusters-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Options
* - -f, --file
- string
- false
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.

Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag.
* - -h, --help
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-clusters-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Options
* - -f, --file
- string
- false
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.

Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag.
* - -h, --help
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-clusters-upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Options
* - -f, --file
- string
- false
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
- Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.

Mutually exclusive with --tier, --diskSizeGB, --mdbVersion, --enableTerminationProtection, --disableTerminationProtection, --tag.
* - -h, --help
Expand Down
4 changes: 2 additions & 2 deletions internal/usage/usage.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ dbName and collection are required only for built-in roles.`
TeamRole = "User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY."
MaxDate = "Maximum created date. This option returns events whose created date is less than or equal to the specified value."
MinDate = "Minimum created date. This option returns events whose created date is greater than or equal to the specified value."
ClusterFilename = "Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli."
ClusterFilename = "Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli."
IndexFilename = "Path to an optional JSON configuration file that defines index settings."
BackupFilename = "Path to an optional JSON configuration file that defines backup schedule settings. To learn about the cloud backup configuration file for the Atlas CLI, see https://dochub.mongodb.org/core/cloud-backup-config-file."
SearchFilename = "Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs."
Expand Down Expand Up @@ -267,7 +267,7 @@ dbName and collection are required only for built-in roles.`
CurrentIPSimplified = "Flag that adds the IP address from the host that is currently executing the command to the access list."
Gov = "Create a default profile for atlas for gov"
EncryptedLogFile = "Path to the file that contains encrypted audit logs."
OutputLogFile = "Path to the file where MongoCLI will save the contents of the decrypted audit log. If not specified, MongoCLI writes the contents of the decrypted audit log to stdout."
OutputLogFile = "Path to the file where Atlas CLI will save the contents of the decrypted audit log. If not specified, Atlas CLI writes the contents of the decrypted audit log to stdout."
GCPServiceAccountKey = "GCP service account key file."
AzureClientID = "Application (client) ID assigned by Azure portal - App registrations experience."
AzureTenantID = "Tenant value in the path of the request can be used to control who can sign into the application."
Expand Down
2 changes: 1 addition & 1 deletion scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ if [[ -z "${VERSION}" ]]; then
exit 1
fi

if [[ "${VERSION}" != mongocli/v* ]] && [[ "${VERSION}" != atlascli/v* ]]; then
if [[ "${VERSION}" != atlascli/v* ]]; then
echo "Please provide a tag version in the format 'atlascli/vX.Y.Z'"
exit 1
fi
Expand Down
6 changes: 3 additions & 3 deletions tools/release/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ func Builder() *cobra.Command {
Use: "main",
Short: "Generate the download center json file",
Example: `
# Generate the download center json file for mongocli
$ main --version 1.23.0 --file mongocli.json`,
# Generate the download center json file for cli
$ main --version 1.23.0 --file atlascli.json`,
RunE: func(cmd *cobra.Command, _ []string) error {
cmd.Printf("Generating JSON: %s\n", opts.fileName)
return generateFile(opts.fileName, opts.version)
Expand All @@ -131,7 +131,7 @@ func Builder() *cobra.Command {
}

cmd.Flags().StringVar(&opts.version, flag.Version, "", "release version.")
cmd.Flags().StringVar(&opts.fileName, flag.File, "mongocli.json", "file name of the download center json file.")
cmd.Flags().StringVar(&opts.fileName, flag.File, "atlascli.json", "file name of the download center json file.")

_ = cmd.MarkFlagFilename(flag.File)
_ = cmd.MarkFlagRequired(flag.Version)
Expand Down

0 comments on commit 1642457

Please sign in to comment.