Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/displague/configuration-metalnetworks
Example Crossplane configuration for provisioning interconnected Equinix Metal Network constructs
https://github.com/displague/configuration-metalnetworks
Last synced: 8 days ago
JSON representation
Example Crossplane configuration for provisioning interconnected Equinix Metal Network constructs
- Host: GitHub
- URL: https://github.com/displague/configuration-metalnetworks
- Owner: displague
- License: apache-2.0
- Created: 2024-09-10T18:03:11.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T00:57:28.000Z (3 months ago)
- Last Synced: 2024-12-13T06:34:58.857Z (10 days ago)
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# configuration-metalnetworks
This is a simple example that demonstrates how to use the Equinix Metal provider to create network infrastructure, including a VLAN, Gateway with VRF, and IP Reservations.
## Usage
TODO: replace this with usage instructions
## Template
TODO: remove this section
A template for writing a [Configuration].
To use this template:
1. Replace the name, metadata in crossplane.yaml to reflect your Configuration.
2. Add dependencies in crossplane.yaml.
3. Update the sample CompositeResourceDefinition and Composition in the `apis/`
directory to reflect the API you're designing for your platform, and optionally add more if needed.
4. Add/Update examples in the `examples/` directory.
5. Update this file, `README.md`, to be about your Configuration!
To build a Configuration package, use the Crossplane CLI:
```shell
# Just builds the package. It will go through the repo and collect yaml files.
# Furthermore it will by default check for examples in `./examples` and add them to the package.
crossplane xpkg build
# You can specify various options for the build command, if needed
crossplane xpkg build --package-root=. --package-file=test-package.xpkg --examples-root=./examples
```
(Optionally) Login to the default xpkg.upbound.io registry:
```shell
crossplane xpkg login
```
Push the package to a registry:
```shell
crossplane xpkg push -f test-package.xpkg your-org/your-repo:v1.0.0
```
More info on the Crossplane CLI can be found [here][xp-cli].
Check out the Crossplane docs for more information on [creating] Configurations.
[Configuration]: https://docs.crossplane.io/latest/concepts/packages
[creating]: https://docs.crossplane.io/latest/concepts/packages/#create-a-configuration
[xp-cli]: https://docs.crossplane.io/latest/cli/command-reference/