provider-mongodbatlas/README.md.tmpl at main · crossplane-contrib/provider-mongodbatlas · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# MongoDBAtlas Provider [![${VERSION}](https://img.shields.io/badge/${VERSION}-green)](https://github.com/crossplane-contrib/provider-mongodbatlas/releases/tag/${VERSION})

`provider-mongodbatlas` is a [Crossplane](https://crossplane.io/) provider that
is built using [Upjet](https://github.com/crossplane/upjet) code
generation tools and exposes XRM-conformant managed resources for the
MongoDBAtlas API.

[![Upstream Terraform Provider](https://img.shields.io/badge/upstream_terraform_provider-v${TERRAFORM_PROVIDER_VERSION}-blue?logo=terraform)](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/v${TERRAFORM_PROVIDER_VERSION})

## Getting Started

Install the provider by using the following command after changing the image tag
to the [latest release](https://github.com/crossplane-contrib/provider-mongodbatlas/releases):

```
kubectl apply -f - <<EOF
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-mongodbatlas
spec:
  package: xpkg.upbound.io/crossplane-contrib/provider-mongodbatlas:${VERSION}
EOF
```

You can see the API reference [here](https://doc.crds.dev/github.com/crossplane-contrib/provider-mongodbatlas).

## Importing a resource

Refer to the [dedicated document](docs/import.md) for information about how to import existing resources.

## Migrating to v1

If you are upgrading from v0.x, refer to the [migration guide](docs/migration-to-v1.md) for breaking changes and a migration script.

## Developing

Run code-generation pipeline:

```console
go run cmd/generator/main.go
```

Run against a Kubernetes cluster (out of cluster):

```console
make run
```

or (deploying in-cluster):

```console
make local-deploy
```

Review your code:

```console
make reviewable
```

Build, push, and install:

```console
make all
```

Build image:

```console
make image
```

Push image:

```console
make push
```

Build binary:

```console
make build
```

## Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please
open an [issue](https://github.com/crossplane-contrib/provider-mongodbatlas/issues).

## Contact

Please use the following to reach members of the community:

* Slack: Join our [slack channel](https://slack.crossplane.io)
* Forums:
  [crossplane-dev](https://groups.google.com/forum/#!forum/crossplane-dev)
* Twitter: [@crossplane_io](https://twitter.com/crossplane_io)
* Email: [info@crossplane.io](mailto:info@crossplane.io)

## Governance and Owners

`provider-mongodbatlas` is run according to the same
[Governance](https://github.com/crossplane/crossplane/blob/master/GOVERNANCE.md)
and [Ownership](OWNERS.md)
structure as the core Crossplane project.

## Code of Conduct

`provider-mongodbatlas` adheres to the same [Code of
Conduct](https://github.com/crossplane/crossplane/blob/master/CODE_OF_CONDUCT.md)
as the core Crossplane project.

## Licensing

`provider-mongodbatlas` is under the Apache 2.0 [license](LICENSE).

This binary includes code from [terraform-provider-mongodbatlas](https://github.com/mongodb/terraform-provider-mongodbatlas)
licensed under the Mozilla Public License 2.0. See [NOTICE](NOTICE) for details.