{"id":18291217,"url":"https://github.com/rhecosystemappeng/dbaas-dynamic-plugin","last_synced_at":"2025-04-05T10:30:58.538Z","repository":{"id":37054988,"uuid":"377588287","full_name":"RHEcosystemAppEng/dbaas-dynamic-plugin","owner":"RHEcosystemAppEng","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-20T14:35:12.000Z","size":893,"stargazers_count":3,"open_issues_count":3,"forks_count":13,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-21T03:02:19.576Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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}},"created_at":"2021-06-16T18:13:38.000Z","updated_at":"2022-11-02T22:10:58.000Z","dependencies_parsed_at":"2023-02-15T12:16:22.972Z","dependency_job_id":null,"html_url":"https://github.com/RHEcosystemAppEng/dbaas-dynamic-plugin","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fdbaas-dynamic-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fdbaas-dynamic-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fdbaas-dynamic-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RHEcosystemAppEng%2Fdbaas-dynamic-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RHEcosystemAppEng","download_url":"https://codeload.github.com/RHEcosystemAppEng/dbaas-dynamic-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247324511,"owners_count":20920660,"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:32.010Z","updated_at":"2025-04-05T10:30:58.056Z","avatar_url":"https://github.com/RHEcosystemAppEng.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DBaaS Dynamic Plugin\n\n## Local development\n\n1. `yarn build` to build the plugin, generating output to `dist` directory\n2. `yarn http-server` to start an HTTP server hosting the generated assets\n\n```\nStarting up http-server, serving ./dist\nAvailable on:\n  http://127.0.0.1:9001\n  http://192.168.1.190:9001\n  http://10.40.192.80:9001\nHit CTRL-C to stop the server\n```\n\nThe server runs on port 9001 with caching disabled and CORS enabled. Additional\n[server options](https://github.com/http-party/http-server#available-options) can be passed to\nthe script, for example:\n\n```sh\nyarn http-server -a 127.0.0.1\n```\n\n3. Go to OCP Console that running locally and use the flowing command to run Bridge.\n\n```\nsource ./contrib/oc-environment.sh \u0026\u0026 go run cmd/bridge/main.go -plugins dbaas-dynamic-plugin=http://127.0.0.1:9001/\n```\n\nFor more details, see the plugin development section in\n[Console Dynamic Plugins README](https://github.com/openshift/console/tree/master/frontend/packages/console-dynamic-plugin-sdk/README.md) for details\non how to run Bridge using local plugins.\n\n## Deployment on cluster\n\nConsole dynamic plugins are supposed to be deployed via [OLM operators](https://github.com/operator-framework).\nIn case of demo plugin, we just apply a minimal OpenShift manifest which adds the necessary resources.\n\n```sh\noc apply -f oc-manifest.yaml\n```\n\nNote that the `Service` exposing the HTTP server is annotated to have a signed\n[service serving certificate](https://docs.openshift.com/container-platform/4.6/security/certificates/service-serving-certificate.html)\ngenerated and mounted into the image. This allows us to run the server with HTTP/TLS enabled, using\na trusted CA certificate.\n\n## Enabling the plugin\n\nOnce deployed on the cluster, demo plugin must be enabled before it can be loaded by Console.\n\nTo enable the plugin manually, edit [Console operator](https://github.com/openshift/console-operator)\nconfig and make sure the plugin's name is listed in the `spec.plugins` sequence (add one if missing):\n\n```sh\noc edit console.operator.openshift.io cluster\n```\n\n```yaml\n# ...\nspec:\n  plugins:\n    - dbaas-dynamic-plugin\n# ...\n```\n\n## Docker image\n\nFollowing commands should be executed in Console repository root.\n\n1. Build the image:\n   ```sh\n   QUAY_USER=\u003cquay user/org\u003e yarn img-build\n   ```\n2. Run the image:\n   ```sh\n   QUAY_USER=\u003cquay user/org\u003e yarn img-run\n   ```\n3. Push the image to image registry:\n   ```sh\n   QUAY_USER=\u003cquay user/org\u003e yarn img-push\n   ```\n\nUpdate and apply `oc-manifest.yaml` to use a custom plugin image.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhecosystemappeng%2Fdbaas-dynamic-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhecosystemappeng%2Fdbaas-dynamic-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhecosystemappeng%2Fdbaas-dynamic-plugin/lists"}