Skip to content

Commit c58e208

Browse files
cveticmcveticm
authored
feat: Adds operator install command (#9)
* Adds operator install * Moves builder() and renames from root to kubernetes * Adds silenceUsage to commands * Adds docs * Moves LoadAtlasCLIConfig to root command * Moves silenceUsage to root command
1 parent 6a77cd1 commit c58e208

File tree

12 files changed

+510
-37
lines changed

12 files changed

+510
-37
lines changed

‎cmd/plugin/main.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,15 @@
1515
package main
1616

1717
import (
18-
"fmt"
1918
"os"
2019

21-
"github.com/mongodb/atlas-cli-plugin-kubernetes/internal/cli/root"
20+
"github.com/mongodb/atlas-cli-plugin-kubernetes/internal/cli/kubernetes"
2221

2322
"github.com/spf13/cobra"
2423
)
2524

2625
func main() {
27-
cmd := root.Builder()
26+
cmd := kubernetes.Builder()
2827

2928
completionOption := &cobra.CompletionOptions{
3029
DisableDefaultCmd: true,
@@ -37,11 +36,11 @@ func main() {
3736
DisableAutoGenTag: true,
3837
DisableSuggestions: true,
3938
CompletionOptions: *completionOption,
39+
SilenceUsage: true,
4040
}
4141
rootCmd.AddCommand(cmd)
4242

4343
if err := rootCmd.Execute(); err != nil {
44-
fmt.Println(err)
4544
os.Exit(1)
4645
}
4746
}

‎docs/command/kubernetes-operator-install.txt

+148
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
.. _kubernetes-operator-install:
2+
3+
===========================
4+
kubernetes operator install
5+
===========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Install Atlas Kubernetes Operator to a cluster.
16+
17+
This command installs a supported version of Atlas Kubernetes Operator to an existing cluster, and optionally imports Atlas resources that are managed by the operator.
18+
19+
This command creates an API key for the Operator and adds it to Kubernetes as a secret, which the Operator then uses to make Atlas Admin API calls.
20+
The key is scoped to the project when you specify the --projectName option and to the organization when you omit the --projectName option.
21+
22+
Syntax
23+
------
24+
25+
.. code-block::
26+
:caption: Command Syntax
27+
28+
kubernetes operator install [options]
29+
30+
.. Code end marker, please don't delete this comment
31+
32+
Options
33+
-------
34+
35+
.. list-table::
36+
:header-rows: 1
37+
:widths: 20 10 10 60
38+
39+
* - Name
40+
- Type
41+
- Required
42+
- Description
43+
* - --atlasGov
44+
-
45+
- false
46+
- Flag that indicates whether to configure Atlas for Government as a target of the operator.
47+
* - -h, --help
48+
-
49+
- false
50+
- help for install
51+
* - --import
52+
-
53+
- false
54+
- Flag that indicates whether to import existing Atlas resources into the cluster for the operator to manage.
55+
* - --kubeContext
56+
- string
57+
- false
58+
- Name of the kubeconfig context to use.
59+
* - --kubeconfig
60+
- string
61+
- false
62+
- Path to the kubeconfig file to use for CLI requests.
63+
* - --operatorVersion
64+
- string
65+
- false
66+
- Version of the operator to install.
67+
* - --orgId
68+
- string
69+
- false
70+
- Organization ID to use. This option overrides the settings in the configuration file or environment variable.
71+
* - --projectName
72+
- string
73+
- false
74+
- Name of the project to create or use with the installed operator.
75+
* - --resourceDeletionProtection
76+
-
77+
- false
78+
- Toggle atlas operator deletion protection for resources like Projects, Deployments, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true.
79+
* - --subresourceDeletionProtection
80+
-
81+
- false
82+
- Toggle atlas operator deletion protection for subresources like Alerts, Integrations, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true.
83+
* - --targetNamespace
84+
- string
85+
- false
86+
- Namespace where to install the operator.
87+
* - --watchNamespace
88+
- strings
89+
- false
90+
- List that contains namespaces that the operator will listen to.
91+
92+
Examples
93+
--------
94+
95+
.. code-block::
96+
:copyable: false
97+
98+
# Install latest version of the operator into the default namespace:
99+
atlas kubernetes operator install
100+
101+
102+
.. code-block::
103+
:copyable: false
104+
105+
# Install the latest version of the operator targeting Atlas for Government instead of regular commercial Atlas:
106+
atlas kubernetes operator install --atlasGov
107+
108+
109+
.. code-block::
110+
:copyable: false
111+
112+
# Install a specific version of the operator:
113+
atlas kubernetes operator install --operatorVersion=1.7.0
114+
115+
116+
.. code-block::
117+
:copyable: false
118+
119+
# Install a specific version of the operator to a namespace and watch only this namespace and a second one:
120+
atlas kubernetes operator install --operatorVersion=1.7.0 --targetNamespace=<namespace> --watchNamespace=<namespace>,<secondNamespace>
121+
122+
123+
.. code-block::
124+
:copyable: false
125+
126+
# Install and import all objects from an organization:
127+
atlas kubernetes operator install --targetNamespace=<namespace> --orgID <orgID> --import
128+
129+
130+
.. code-block::
131+
:copyable: false
132+
133+
# Install and import objects from a specific project:
134+
atlas kubernetes operator install --targetNamespace=<namespace> --orgID <orgID> --projectName <project> --import
135+
136+
137+
.. code-block::
138+
:copyable: false
139+
140+
# Install the operator and disable deletion protection:
141+
atlas kubernetes operator install --resourceDeletionProtection=false
142+
143+
144+
.. code-block::
145+
:copyable: false
146+
147+
# Install the operator and disable deletion protection for sub-resources (Atlas project integrations, private endpoints, etc.):
148+
atlas kubernetes operator install --subresourceDeletionProtection=false

‎docs/command/kubernetes-operator.txt

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _kubernetes-operator:
2+
3+
===================
4+
kubernetes operator
5+
===================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Manage Atlas Kubernetes Operator.
16+
17+
This command manages the Atlas Kubernetes Operator.
18+
19+
Options
20+
-------
21+
22+
.. list-table::
23+
:header-rows: 1
24+
:widths: 20 10 10 60
25+
26+
* - Name
27+
- Type
28+
- Required
29+
- Description
30+
* - -h, --help
31+
-
32+
- false
33+
- help for operator
34+
35+
Related Commands
36+
----------------
37+
38+
* :ref:`kubernetes-operator-install` - Install Atlas Kubernetes Operator to a cluster.
39+
40+
41+
.. toctree::
42+
:titlesonly:
43+
44+
install </command/kubernetes-operator-install>
45+

‎docs/command/kubernetes.txt

+2
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@ Related Commands
3636
----------------
3737

3838
* :ref:`kubernetes-config` - Manage Kubernetes configuration resources.
39+
* :ref:`kubernetes-operator` - Manage Atlas Kubernetes Operator.
3940

4041

4142
.. toctree::
4243
:titlesonly:
4344

4445
config </command/kubernetes-config>
46+
operator </command/kubernetes-operator>
4547

‎internal/cli/kubernetes/config/config.go

-9
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@
1515
package config
1616

1717
import (
18-
"log"
19-
20-
"github.com/mongodb/atlas-cli-core/config"
2118
"github.com/spf13/cobra"
2219
)
2320

@@ -27,12 +24,6 @@ func Builder() *cobra.Command {
2724
Use: use,
2825
Short: "Manage Kubernetes configuration resources.",
2926
Long: `This command provides your Kubernetes configuration access to Atlas.`,
30-
PersistentPreRun: func(_ *cobra.Command, _ []string) {
31-
err := config.LoadAtlasCLIConfig()
32-
if err != nil {
33-
log.Fatalf("Failed to load Atlas CLI config: %v", err)
34-
}
35-
},
3627
}
3728

3829
cmd.AddCommand(GenerateBuilder())

‎internal/cli/root/root.go ‎internal/cli/kubernetes/kubernetes.go

+12-2
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,14 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package root
15+
package kubernetes
1616

1717
import (
18+
"log"
19+
20+
coreConfig "github.com/mongodb/atlas-cli-core/config"
1821
"github.com/mongodb/atlas-cli-plugin-kubernetes/internal/cli/kubernetes/config"
22+
"github.com/mongodb/atlas-cli-plugin-kubernetes/internal/cli/kubernetes/operator"
1923

2024
"github.com/spf13/cobra"
2125
)
@@ -27,8 +31,14 @@ func Builder() *cobra.Command {
2731
Use: use,
2832
Short: "Manage Kubernetes resources.",
2933
Long: `This command provides access to Kubernetes features within Atlas.`,
34+
PersistentPreRun: func(_ *cobra.Command, _ []string) {
35+
err := coreConfig.LoadAtlasCLIConfig()
36+
if err != nil {
37+
log.Fatalf("Failed to load Atlas CLI config: %v", err)
38+
}
39+
},
3040
}
3141

32-
cmd.AddCommand(config.Builder())
42+
cmd.AddCommand(config.Builder(), operator.Builder())
3343
return cmd
3444
}

0 commit comments

Comments
 (0)