{"id":19075884,"url":"https://github.com/instaclustr/operator","last_synced_at":"2025-04-30T00:22:20.865Z","repository":{"id":181447310,"uuid":"531768877","full_name":"instaclustr/operator","owner":"instaclustr","description":"Instaclustr Kubernetes Operator","archived":false,"fork":false,"pushed_at":"2024-11-05T09:31:50.000Z","size":11813,"stargazers_count":2,"open_issues_count":14,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-18T20:49:09.302Z","etag":null,"topics":["netapp-public"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/instaclustr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-02T03:31:00.000Z","updated_at":"2024-11-05T09:31:56.000Z","dependencies_parsed_at":"2023-12-22T15:45:11.790Z","dependency_job_id":"a5f7a6b3-c765-4e12-ab2f-e72c1550b32c","html_url":"https://github.com/instaclustr/operator","commit_stats":null,"previous_names":["instaclustr/operator"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instaclustr%2Foperator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instaclustr%2Foperator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instaclustr%2Foperator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instaclustr%2Foperator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instaclustr","download_url":"https://codeload.github.com/instaclustr/operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251603890,"owners_count":21616167,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["netapp-public"],"created_at":"2024-11-09T01:56:20.156Z","updated_at":"2025-04-30T00:22:20.846Z","avatar_url":"https://github.com/instaclustr.png","language":"Go","readme":"# Instaclustr Operator\nThe Instaclustr Operator allows users to deploy, scale and manage any one of\ndata layer technologies deployed on the Instaclustr platform from within Kubernetes.\n\n## Description\nThe Instaclustr Operator provides all the same functionality as the Instaclustr API,\nInstaclustr Console and Instaclustr terraform provider. \n- Removes the need to write custom code integration directly with the Instaclustr API\n- Use of existing Instaclustr authentication methodologies\n- Declare Instaclustr infrastructure up front\n- Scale, modify and change Instaclustr infrastructure with\n  existing Kubernetes management tools / workflows\n- Simplify Kubernetes native development workflow patterns\n  (CI/CD integrations, production deployments etc).\n\n## Getting Started\nYou’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.\n**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).\n\n### Running on the cluster\n1. Create the .env file inside your home folder (~/.env), copy all content from the .env.tmpl and fill variables. When the operator deploys, it will create the secret from these variables to access the Instaclustr API.\nCreate the config/manager/kustomization.yaml file and copy all content from the config/manager/kustomization.yaml.tmpl. Also, be sure that you've already installed the pre-commit hook. Use `make install-pre-commit` to accomplish. It will prevent you from pushing secret data to the public repository.\n\n2. Deploy the cert-manager:\n\n```sh\nmake cert-deploy\n```\n\n3. Build and push your image to the location specified by `IMG`:\n\t\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/operator:tag\n```\n\n4. Deploy the controller to the cluster with the image specified by `IMG`:\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/operator:tag\n```\n\n5. Install needed instances of Custom Resources:\n\n```sh\nkubectl apply -f config/samples/\u003cresource-group\u003e/\u003cresource-name.yaml\u003e\n```\n\n**NOTE:** You can also run `IMG=\u003csome-registry\u003e/operator:tag make` to simply install the controller\n\n### Uninstall CRDs\nTo delete all CRDs from the cluster:\n\n```sh\nmake uninstall\n```\n\n### Undeploy controller\nUndeploy the controller from the cluster:\n\n```sh\nmake undeploy\n```\n\n### Undeploy cert-manager\nUndeploy the cert manager:\n\n```sh\nmake cert-undeploy\n```\n\n## Contributing\n\nWe welcome all contributors. Please see our public [contributing guidelines](CONTRIBUTING.md).\n\n\n### How it works\nThis project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)\n\nIt uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) \nwhich provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster \n\n### Test It Out\n1. Run the controller tests:\n\n```sh\nmake test\n```\n\n### Modifying the API definitions\nIf you are editing the API definitions, generate the manifests such as CRs or CRDs using:\n\n```sh\nmake manifests\n```\n\n**NOTE:** Run `make --help` for more information on all potential `make` targets\n\nMore information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)\n\n## Support Contact\n\nPlease reach out to support@instaclustr.com for issues with this Instaclustr Operator. Please note that we've disabled the issues feature on this repository.\n\nThe support status of this project is available through https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/.\n\n\n## C4 model diagrams\n\n|                             Context diagram                             |  Container diagram                                       |  Component diagram|\n|:-----------------------------------------------------------------------:|:--------------------------------------------------------:|:-------------------------:|\n| ![Context diagram](doc/diagrams/context_diagram.png \"Context diagram\")  |  ![Container diagram](doc/diagrams/container_diagram.png) |  ![Component diagram](doc/diagrams/component_diagram.png)|\n\n|                             CRDs Relations                              |\n| :---------------------------------------------------------------------: |\n|       ![CRD Relations](doc/diagrams/crd_relations.png \"CRD Relations\")  |\n\n\n\n## License\n\nApache2 - See the included LICENSE file for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstaclustr%2Foperator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstaclustr%2Foperator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstaclustr%2Foperator/lists"}