https://github.com/yandex-cloud/crossplane-provider-yc
Yandex Cloud Crossplane Provider
https://github.com/yandex-cloud/crossplane-provider-yc
crossplane kubernetes yandex-cloud
Last synced: 2 months ago
JSON representation
Yandex Cloud Crossplane Provider
- Host: GitHub
- URL: https://github.com/yandex-cloud/crossplane-provider-yc
- Owner: yandex-cloud
- License: other
- Created: 2021-12-13T10:23:48.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-12T21:24:32.000Z (2 months ago)
- Last Synced: 2025-08-12T23:27:00.930Z (2 months ago)
- Topics: crossplane, kubernetes, yandex-cloud
- Language: Go
- Homepage:
- Size: 30.9 MB
- Stars: 38
- Watchers: 13
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Yandex Cloud Crossplane Provider
`crossplane-provider-yc` 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 [Yandex Cloud](https://cloud.yandex.com/).
## Getting Started
### Install crossplane-provider-yc
Install crossplane:
```
kubectl create namespace crossplane-system
helm repo add crossplane-stable https://charts.crossplane.io/stable
helm repo update
helm install crossplane --namespace crossplane-system crossplane-stable/crossplane
```
Check crossplane status:
```
helm list -n crossplane-system
kubectl get all -n crossplane-system
```
Install crossplane CLI:
```shell
curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh && \
sudo mv crossplane $(dirname $(which kubectl))
```
Install the provider by using the following command after changing tag to the latest release:
```
crossplane xpkg install provider xpkg.upbound.io/yandexcloud/crossplane-provider-yc:v0.4.1
```
### Setup ProviderConfig
Create service account:
```
yc iam service-account create --name
```
Add roles to this service account:
```shell
yc resource-manager folder add-access-binding --role
```
Request key:
```shell
yc iam key create --service-account-id --output key.json
```
Create k8s secret:
```shell
kubectl create secret generic yc-creds -n "crossplane-system" --from-file=credentials=./key.json
```
Apply example ProviderConfig:
```
kubectl apply -f examples/providerconfig/providerconfig.yaml
```
### Update crossplane-provider-yc
Update provider version on new tag (e.g. v0.4.1):
```
kubectl crossplane update provider crossplane-provider-yc v0.4.1
```
## Useful things
### Reconcile existing resources:
Add existing resource id `metadata.annotations["crossplane.io/external-name"]`
```yaml
metadata:
annotations:
crossplane.io/external-name:
```
To avoid making changes to an existing resouce that needs to be references (folder, subnet, etc.),
add `spec.managementPolicy: ObserveOnly`
```yaml
spec:
managementPolicy: ObserveOnly
```
### Do not delete external resource with `kubectl delete`
Add `spec.deletionPolicy: Orphan`
```yaml
spec:
deletionPolicy: Orphan
```
```shell
❯ k explain Folder.spec.deletionPolicy
KIND: Folder
VERSION: resourcemanager.yandex-cloud.jet.crossplane.io/v1alpha1
FIELD: deletionPolicy
DESCRIPTION:
DeletionPolicy specifies what will happen to the underlying external when
this managed resource is deleted - either "Delete" or "Orphan" the external
resource.
```
You can enforce `deletionPolicy: Orphan` with gatekeeper if you need.
## Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please open
an [issue](https://github.com/yandex-cloud/crossplane-provider-yc/issues).