{"id":18291184,"url":"https://github.com/rhecosystemappeng/nifi-operator","last_synced_at":"2025-10-14T04:11:00.263Z","repository":{"id":39599397,"uuid":"505462305","full_name":"RHEcosystemAppEng/nifi-operator","owner":"RHEcosystemAppEng","description":"Apache Nifi Operator for Openshift","archived":false,"fork":false,"pushed_at":"2024-06-26T11:14:04.000Z","size":57536,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-21T02:51:18.037Z","etag":null,"topics":[],"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/RHEcosystemAppEng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2022-06-20T13:53:38.000Z","updated_at":"2025-03-15T04:37:04.000Z","dependencies_parsed_at":"2024-06-04T18:46:40.732Z","dependency_job_id":null,"html_url":"https://github.com/RHEcosystemAppEng/nifi-operator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fnifi-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fnifi-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fnifi-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fnifi-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RHEcosystemAppEng","download_url":"https://codeload.github.com/RHEcosystemAppEng/nifi-operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247324507,"owners_count":20920659,"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":[],"created_at":"2024-11-05T14:13:27.084Z","updated_at":"2025-10-14T04:10:55.231Z","avatar_url":"https://github.com/RHEcosystemAppEng.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RedHat Ecosystem Application Engineering Apache Nifi Operator\n**Project Status:** Under development!\n\nThe API, spec, status and other aspects of the operator could change in future\nversions.\n\n\n## Overview\nThis operator pretends to provide a Kubernetes/Openshift deployment of [Apache\nNifi](https://nifi.apache.org/) instances and cluster deployments.\n\n## Operator Deployment\nTo run the operator locally you will need to have `kubectl` or `oc` CLIs already\nconfigured and with a login session. To start, run the following commands:\n```sh\nmake install run\n```\n\n\nRun the following to deploy the operator. This will also install the RBAC manifests\nfrom `config/rbac`.\n\n```sh\nmake deploy\n```\n\n## Nifi Deployment\nIf you are using Openshift, please go to [Openshift Nifi\nPrepare](#openshift-nifi-prepare) before to start, some pre-steps should be\nperformed. This includes to create a ServiceAccount which binds with the correct\npermissions and SCC to be able to create the Pods. If you are on Kubernetes, go\ndirectly to [Nifi example deployment](#nifi-example-deployment).\n\n### Openshift Nifi prepare\nPlease run the following steps before to start:\n1. Define your Namespace where you're going to deploy Nifi.\n```sh\nexport NIFI_NAMESPACE=\u003cyour-namespace\u003e\nkubectl create ns $NIFI_NAMESPACE\n```\n\n2. Create the `nifi` ServiceAccount.\n```sh\nkubectl apply -f - \u003c\u003c _EOF_\nkind: ServiceAccount\napiVersion: v1\nmetadata:\n  name: nifi\n  namespace: $NIFI_NAMESPACE\n\n_EOF_\n```\n\n3. Assign the correct role\n```sh\nkubectl apply -f - \u003c\u003c _EOF_\nkind: RoleBinding\napiVersion: rbac.authorization.k8s.io/v1\nmetadata:\n  name: nifi\n  namespace: $NIFI_NAMESPACE\nsubjects:\n  - kind: ServiceAccount\n    name: nifi\n    namespace: $NIFI_NAMESPACE\nroleRef:\n  apiGroup: rbac.authorization.k8s.io\n  kind: ClusterRole\n  name: admin\n\n_EOF_\n```\n\n### Nifi example deployment\nTo deploy a Nifi instance start from the following example. This provides a\nsimple Nifi instance with HTTPS protocol enabled and the default admin user\ncredentials.\n```yaml\nkubectl apply -f - \u003c\u003c _EOF_\napiVersion: bigdata.quay.io/v1alpha1\nkind: Nifi\nmetadata:\n  name: nifi-example\n  namespace: $NIFI_NAMESPACE\nspec:\n  replicas: 1\n  useDefaultCredentials: true\n  console:\n    expose: true\n    protocol: \"https\"\n\n_EOF_\n```\n\nThe default credentials are (*WARNING: This mode should be only used for\ndevelopment purposes.*):\n* **Admin user:** `administrator`\n* **Admin password:** `administrator`\n\n## Nifi Spec\nThis section explains every field in the Nifi's spec:\n\n| Parameter | Description | Values |\n|-----------|-------------|--------|\n| spec.replicas | Number of Nifi instances to be deployed. Cluster features under development. Still using 1. | Integer \u003e= 0 |\n| spec.useDefaultCredentials | Configure Nifi with the default admin user credentials. If not, check the Nifi's logs to figure out the default credentials provisioned by Nifi | Boolean (true, false) |\n| spec.console | Nifi Console Spec | *struct* |\n| spec.console.expose | Creates a Openshift route if it sets to 'true' | Boolean (true, false) |\n| spec.console.protocol | Enables the HTTPS protocol at Nifi's instance with a self-signed certificate, or deploy it using HTTP | \"https\", \"http\" |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhecosystemappeng%2Fnifi-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhecosystemappeng%2Fnifi-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhecosystemappeng%2Fnifi-operator/lists"}