├── .asciidoctor ├── docinfo-footer.html ├── docinfo.html └── docs.css ├── .asciidoctorconfig ├── .editorconfig ├── .github ├── pull_request_template.md └── workflows │ ├── build-asciidoc.yml │ ├── generate-supported-plugins-pr.yml │ ├── pr.yml │ └── style-guide.yml ├── .gitignore ├── .htmltest.yml ├── .prettierrc.yml ├── .sync └── sync-manual-trigger.png ├── .vale-styles └── DeveloperHub │ ├── Attributes.yml │ └── tests │ ├── .vale.ini │ ├── fail.adoc │ └── pass.adoc ├── .vale.ini ├── .vscode └── settings.json ├── CONTRIBUTING.md ├── DCO ├── LICENSE ├── README.adoc ├── README.sync.adoc ├── artifacts ├── attributes.adoc ├── docinfo.xml ├── rhdh-plugins-reference │ ├── aap-backend │ │ ├── aap-backend-install-dynamic-plugin.adoc │ │ └── aap-backend-plugin-readme.adoc │ ├── acr │ │ ├── acr-install-dynamic-plugin.adoc │ │ └── acr-plugin-readme.adoc │ ├── argocd │ │ ├── argocd-plugin-admin.adoc │ │ ├── argocd-plugin-readme.adoc │ │ └── argocd-plugin-user.adoc │ ├── attributes.adoc │ ├── images │ ├── jfrog-artifactory │ │ ├── jfrog-artifactory-plugin-admin.adoc │ │ ├── jfrog-artifactory-plugin-user.adoc │ │ ├── jfrog-install-dynamic-plugin.adoc │ │ └── jfrog-plugin-readme.adoc │ ├── keycloak │ │ ├── keycloak-plugin-admin.adoc │ │ ├── keycloak-plugin-readme.adoc │ │ └── keycloak-plugin-user.adoc │ ├── modules │ ├── nexus-repository-manager │ │ ├── nexus-repository-manager-install-dynamic-plugin.adoc │ │ ├── nexus-repository-manager-plugin-admin.adoc │ │ ├── nexus-repository-manager-plugin-readme.adoc │ │ └── nexus-repository-manager-plugin-user.adoc │ ├── ocm │ │ ├── ocm-backend-plugin-readme.adoc │ │ ├── ocm-common-plugin-readme.adoc │ │ └── ocm-plugin-readme.adoc │ ├── quay │ │ ├── quay-install-dynamic-plugin.adoc │ │ └── quay-plugin-readme.adoc │ ├── snip-concious-language.adoc │ ├── tekton │ │ ├── tekton-install-dynamic-plugin.adoc │ │ ├── tekton-plugin-admin.adoc │ │ ├── tekton-plugin-readme.adoc │ │ └── tekton-plugin-user.adoc │ └── topology │ │ ├── topology-install-dynamic-plugin.adoc │ │ ├── topology-plugin-admin.adoc │ │ ├── topology-plugin-readme.adoc │ │ └── topology-plugin-user.adoc ├── snip-conscious-language.adoc ├── snip-developer-preview.adoc ├── snip-dynamic-plugins-support.adoc ├── snip-rhdh-install-operator-next-steps.adoc └── snip-technology-preview.adoc ├── assemblies ├── assembly-about-rhdh.adoc ├── assembly-about-software-catalogs.adoc ├── assembly-adoption-insights.adoc ├── assembly-audit-log.adoc ├── assembly-authenticating-with-github.adoc ├── assembly-authenticating-with-microsoft-azure.adoc ├── assembly-authenticating-with-rhbk.adoc ├── assembly-authenticating-with-the-guest-user.adoc ├── assembly-bulk-importing-from-github.adoc ├── assembly-configuring-a-floating-action-button.adoc ├── assembly-configuring-a-proxy.adoc ├── assembly-configuring-authorization-in-rhdh.adoc ├── assembly-configuring-default-secret-pvc-mounts.adoc ├── assembly-configuring-external-postgresql-databases.adoc ├── assembly-configuring-guest-access-with-rbac-ui.adoc ├── assembly-configuring-high-availability.adoc ├── assembly-configuring-readonlyrootfilesystem.adoc ├── assembly-configuring-techdocs.adoc ├── assembly-configuring-templates.adoc ├── assembly-configuring-the-global-header.adoc ├── assembly-customizing-segment-source.adoc ├── assembly-customizing-the-appearance.adoc ├── assembly-customizing-the-homepage.adoc ├── assembly-customizing-the-learning-paths.adoc ├── assembly-customizing-the-quick-access-card.adoc ├── assembly-customizing-the-tech-radar-page.adoc ├── assembly-delegating-rbac-access-rhdh.adoc ├── assembly-disabling-telemetry-data-collection.adoc ├── assembly-enabling-authentication.adoc ├── assembly-enabling-telemetry-data-collection.adoc ├── assembly-install-rhdh-airgapped-environment-k8s-helm.adoc ├── assembly-install-rhdh-airgapped-environment-ocp-helm.adoc ├── assembly-install-rhdh-airgapped-environment-ocp-operator.adoc ├── assembly-install-rhdh-eks-operator.adoc ├── assembly-install-rhdh-ocp-helm.adoc ├── assembly-install-rhdh-ocp-operator.adoc ├── assembly-install-rhdh-osd-gcp.adoc ├── assembly-logging-with-amazon-cloudwatch.adoc ├── assembly-managing-authorizations-by-using-external-files.adoc ├── assembly-managing-authorizations-by-using-the-rest-api.adoc ├── assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc ├── assembly-managing-labels-annotations-topology.adoc ├── assembly-monitoring-and-logging-aks.adoc ├── assembly-monitoring-and-logging-with-aws.adoc ├── assembly-monitoring-with-amazon-prometheus.adoc ├── assembly-provisioning-a-custom-configuration.adoc ├── assembly-release-notes-fixed-issues.adoc ├── assembly-release-notes-known-issues.adoc ├── assembly-rhdh-integration-aks.adoc ├── assembly-rhdh-observability.adoc ├── assembly-techdocs-add-docs.adoc ├── assembly-techdocs-addons-installing.adoc ├── assembly-techdocs-addons-removing.adoc ├── assembly-techdocs-addons-using.adoc ├── assembly-techdocs-addons.adoc ├── assembly-topology-plugin-configure.adoc ├── assembly-upgrade-rhdh.adoc ├── assembly-using-kubernetes-custom-actions.adoc ├── assembly-using-servicenow.adoc ├── assembly-using-techdocs.adoc ├── dynamic-plugins │ ├── assembly-about-rhdh-plugins.adoc │ ├── assembly-configuring-rhdh-plugins.adoc │ ├── assembly-extensions-plugins.adoc │ ├── assembly-install-third-party-plugins-rhdh.adoc │ ├── assembly-install-topology-plugin.adoc │ ├── assembly-installing-rhdh-plugins.adoc │ ├── assembly-package-publish-third-party-dynamic-plugin.adoc │ ├── assembly-reference-rhdh-plugins.adoc │ ├── assembly-rhdh-installing-dynamic-plugins.adoc │ ├── assembly-third-party-plugins.adoc │ ├── assembly-troubleshooting-rhdh-plugins.adoc │ ├── assembly-using-rhdh-plugins.adoc │ ├── assembly-using-the-dynamic-plugins-cache.adoc │ └── assembly-using-topology-plugin.adoc └── modules ├── build └── scripts │ ├── build-ccutil.sh │ └── build.sh ├── images ├── rhdh-plugins-reference │ ├── aap-backend-plugin-user1.png │ ├── aap-backend-plugin-user2.png │ ├── acr-plugin-user1.png │ ├── active-users.jpg │ ├── adoption-insights-catalog-entities.jpg │ ├── adoption-insights-daterange.jpg │ ├── adoption-insights.jpg │ ├── argo-cd-plugin-history.png │ ├── argo-cd-plugin-overview-card-details.png │ ├── argo-cd-plugin-overview-card.png │ ├── argocd.png │ ├── deployment_summary.png │ ├── dynatrace-certified-and-verified.png │ ├── extensions-catalog-sidebar.png │ ├── extensions-catalog.png │ ├── jfrog-artifactory.png │ ├── jfrog-plugin-user1.png │ ├── link.png │ ├── nexus-repository-manager.png │ ├── ocm-plugin-user1.png │ ├── ocm-plugin-user2.png │ ├── quay-plugin-backstage1.png │ ├── quay-plugin-backstage2.png │ ├── quay-plugin-backstage3.png │ ├── rhdh-extensions-tekton-card.png │ ├── rhdh-extensions-tekton-details.png │ ├── rhdh-extensions-tekton-editor-1.png │ ├── rhdh-extensions-tekton-editor-2.png │ ├── sidebar.png │ ├── tekton-plugin-pipeline-expand.png │ ├── tekton-plugin-pipeline.png │ ├── tekton-plugin-user1.png │ ├── tekton-plugin-user2.png │ ├── tekton-plugin-user3.png │ ├── topology-tab-user1.png │ ├── topology-tab-user2.png │ └── topology-tab-user3.png ├── rhdh │ ├── disabling-telemetry.png │ ├── enable-gh-discovery.png │ ├── enable-gh-member-discovery.png │ ├── example-callback-url.png │ ├── helm-upgrade.png │ ├── operator-install-1.png │ ├── operator-install-2.png │ ├── rhdh-helm-install.png │ ├── segment-source-helm.png │ ├── template-creation-not-successful.png │ ├── template-creation-successful.png │ ├── template-editor.png │ └── upgrade-helm-metrics.png └── user-guide │ └── custom-theme-mode-1.png ├── modules ├── about │ ├── con-benefits-of-rhdh.adoc │ ├── con-integrations-in-rhdh.adoc │ ├── con_understanding-internal-developer-platforms.adoc │ ├── ref-customer-support-info.adoc │ ├── ref-rhdh-sizing.adoc │ └── ref-supported-platforms.adoc ├── analytics │ ├── con-telemetry-data-collection-and-analysis.adoc │ ├── proc-customizing-segment-source-using-helm-the-helm-chart.adoc │ ├── proc-customizing-segment-source-using-the-operator.adoc │ ├── proc-disabling-telemetry-using-helm.adoc │ ├── proc-disabling-telemetry-using-operator.adoc │ ├── proc-enabling-telemetry-using-helm.adoc │ └── proc-enabling-telemetry-using-operator.adoc ├── authentication │ ├── proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc │ ├── proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc │ ├── proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc │ ├── proc-enabling-authentication-with-github.adoc │ ├── proc-enabling-authentication-with-microsoft-azure.adoc │ ├── proc-enabling-authentication-with-rhbk.adoc │ ├── proc-provisioning-users-from-github-to-the-software-catalog.adoc │ ├── proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc │ └── proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc ├── authorization │ ├── con-rbac-conditional-policies-rhdh.adoc │ ├── con-user-stats-rhdh.adoc │ ├── proc-configuring-the-RBAC-backend-plugin.adoc │ ├── proc-defining-authorizations-in-external-files-by-using-helm.adoc │ ├── proc-defining-authorizations-in-external-files-by-using-the-operator.adoc │ ├── proc-delegating-rbac-access-api.adoc │ ├── proc-delegating-rbac-access-webui.adoc │ ├── proc-determining-permission-policy-and-role-configuration-source.adoc │ ├── proc-download-user-stats-rhdh.adoc │ ├── proc-enabling-the-rbac-plugin.adoc │ ├── proc-rbac-ui-create-role.adoc │ ├── proc-rbac-ui-delete-role.adoc │ ├── proc-rbac-ui-edit-role.adoc │ ├── proc-sending-request-to-the-rbac-rest-api-by-using-a-rest-client.adoc │ ├── proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc │ ├── proc-setting-up-the-guest-authentication-provider.adoc │ ├── proc_enabling_transitive_parent_groups.adoc │ ├── ref-rbac-conditional-policy-definition.adoc │ ├── ref-rbac-permission-policies.adoc │ ├── ref-rbac-rest-api-endpoints.adoc │ └── snip-finding-bearer-token.adoc ├── con-rhdh-plugins.adoc ├── configuring-a-floating-action-button │ ├── proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc │ └── ref-floating-action-button-parameters.adoc ├── configuring-a-proxy │ ├── con-understanding-the-no_proxy-exclusion-rules.adoc │ ├── proc-configuring-proxy-in-helm-deployment.adoc │ └── proc-configuring-proxy-in-operator-deployment.adoc ├── configuring-deployment │ └── proc-configuring-deployment-by-using-the-operator.adoc ├── configuring-external-databases │ ├── proc-configuring-mount-paths.adoc │ ├── proc-configuring-postgresql-instance-using-helm.adoc │ ├── proc-configuring-postgresql-instance-using-the-operator.adoc │ ├── proc-migrating-databases-to-an-external-server.adoc │ ├── proc-mount-directories-pvcs.adoc │ ├── proc-mounting-to-specific-containers.adoc │ └── procedure-understanding-no-proxy.adoc ├── configuring-high-availability │ ├── proc-configuring-high-availability-in-rhdh-helm-chart-deployment.adoc │ └── proc-configuring-high-availability-in-rhdh-operator-deployment.adoc ├── configuring-readonlyrootfilesystem │ ├── proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment.adoc │ └── proc-configuring-readonlyrootfilesystem-option-in-rhdh-operator-deployment.adoc ├── configuring-the-global-header │ ├── proc-customize-rhdh-global-header.adoc │ └── proc-mount-points.adoc ├── configuring │ ├── proc-enabling-the-rhdh-plugin-assets-cache.adoc │ ├── proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc │ ├── proc-provisioning-your-custom-configuration.adoc │ ├── proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc │ └── proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc ├── conscious-language.adoc ├── customizing-techdocs │ ├── con-techdocs-config-cicd.adoc │ ├── con-techdocs-configure-storage.adoc │ ├── proc-techdocs-config-cicd-prep-repo.adoc │ ├── proc-techdocs-configure-odf-helm.adoc │ ├── proc-techdocs-configure-odf-operator.adoc │ ├── proc-techdocs-generate-site.adoc │ ├── proc-techdocs-publish-site.adoc │ ├── proc-techdocs-using-odf-storage.adoc │ ├── ref-techdocs-example-config-plugin-helm.adoc │ └── ref-techdocs-example-config-plugin-operator.adoc ├── customizing-templates │ ├── proc-adding-templates.adoc │ ├── proc-creating-a-new-software-component-using-templates.adoc │ ├── proc-creating-templates.adoc │ ├── proc-searching-and-filtering-software-templates.adoc │ └── ref-creating-templates.adoc ├── customizing-the-appearance │ ├── con-customize-rhdh-sidebar-menuitems.adoc │ ├── proc-configuring-dynamic-plugin-menuitem.adoc │ ├── proc-customize-rhdh-branding-logo.adoc │ ├── proc-customize-rhdh-font.adoc │ ├── proc-customize-rhdh-page-theme.adoc │ ├── proc-customize-rhdh-palette.adoc │ ├── proc-customize-rhdh-sidebar-menuitems.adoc │ ├── proc-customize-rhdh-theme-mode.adoc │ ├── proc-customizing-entity-detail-tab-layout.adoc │ ├── proc-customizing-entity-tab-titles.adoc │ ├── proc-loading-custom-theme-using-dynamic-plugin.adoc │ ├── proc-modifying-or-adding-rhdh-custom-menuitem.adoc │ ├── ref-customize-rhdh-custom-components.adoc │ ├── ref-customize-rhdh-default-backstage.adoc │ └── ref-customize-rhdh-default-rhdh.adoc ├── customizing-the-home-page │ ├── proc-customizing-the-home-page-cards.adoc │ └── proc-defining-the-layout-of-the-product-home-page.adoc ├── customizing-the-learning-paths │ ├── con-about-learning-paths.adoc │ ├── proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc │ ├── proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc │ └── proc-starting-and-completing-lessions-in-learning-paths.adoc ├── customizing-the-quick-access-card │ ├── proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc │ └── proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc ├── customizing-the-tech-radar-page │ ├── proc-customizing-the-tech-radar-page-by-using-a-customization-service.adoc │ └── proc-customizing-the-tech-radar-page-by-using-a-json-file.adoc ├── customizing │ ├── proc-customizing-rhdh-metadata-card.adoc │ ├── proc-customizing-the-backend-secret.adoc │ ├── proc-customizing-your-product-base-url.adoc │ └── proc-customizing-your-product-title.adoc ├── dynamic-plugins │ ├── con-ansible-plugin-admin.adoc │ ├── con-ansible-plugin-user.adoc │ ├── con-ansible-plugin.adoc │ ├── con-basic-config-dynamic-plugins.adoc │ ├── con-catalog-searching-and-filtering.adoc │ ├── con-dynamic-plugins-cache.adoc │ ├── con-install-dynamic-plugin-helm.adoc │ ├── con-preinstalled-dynamic-plugins.adoc │ ├── con-preinstalled-dynamic-plugins.template.adoc │ ├── con-rhdh-plugins.adoc │ ├── proc-app-grouping.adoc │ ├── proc-catalog-viewing.adoc │ ├── proc-config-dynamic-plugins-rhdh-operator.adoc │ ├── proc-create-plugin-js-package.adoc │ ├── proc-create-plugin-oci-image.adoc │ ├── proc-create-plugin-tgz-file.adoc │ ├── proc-creating-a-pvc-for-the-dynamic-plugin-cache-by-using-helm.adoc │ ├── proc-creating-a-pvc-for-the-dynamic-plugin-cache-by-using-the-operator.adoc │ ├── proc-enable-plugins-rhdh-container-image.adoc │ ├── proc-enable-users-to-use-topology-plugin.adoc │ ├── proc-enabling-the-source-code-editor.adoc │ ├── proc-entity-annotation-or-label.adoc │ ├── proc-export-third-party-plugins-rhdh.adoc │ ├── proc-extensions-creating.adoc │ ├── proc-extensions-disabling.adoc │ ├── proc-extensions-installing.adoc │ ├── proc-extensions-managing.adoc │ ├── proc-icon-displayed-in-the-node.adoc │ ├── proc-install-plugins-using-custom-npm-registry.adoc │ ├── proc-label-selector-query-annotation.adoc │ ├── proc-linking-to-source-code-editor-or-source.adoc │ ├── proc-load-plugin-js-package.adoc │ ├── proc-load-plugin-oci-image.adoc │ ├── proc-load-plugin-tgz-file.adoc │ ├── proc-namespace-annotation.adoc │ ├── proc-node-connector.adoc │ ├── proc-obtaining-integrity-checksum.adoc │ ├── proc-overriding-core-backend-services.adoc │ ├── proc-rhdh-example-external-dynamic-plugins.adoc │ ├── proc-rhdh-installing-external-dynamic-plugins-airgapped.adoc │ ├── proc-topology-install.adoc │ ├── proc-using-topology-plugin.adoc │ ├── proc-viewing-installed-plugins.adoc │ ├── proc-viewing-openshift-routes.adoc │ ├── proc-viewing-pod-logs.adoc │ ├── proc-viewing-tekton-pipelineruns.adoc │ ├── proc-viewing-virtual-machines.adoc │ ├── ref-catalog-plugin.adoc │ ├── ref-community-plugins.adoc │ ├── ref-community-plugins.template.adoc │ ├── ref-configuring-the-dynamic-plugins-cache.adoc │ ├── ref-example-dynamic-plugin-helm-installations.adoc │ ├── ref-example-third-party-plugin-installation.adoc │ ├── ref-rh-compatible-plugins.adoc │ ├── ref-rh-supported-plugins.adoc │ ├── ref-rh-supported-plugins.template.adoc │ ├── ref-rh-tech-preview-plugins.adoc │ ├── ref-rh-tech-preview-plugins.template.adoc │ ├── rhdh-supported-plugins.csv │ └── rhdh-supported-plugins.sh ├── importing-repositories │ ├── procedure-enabling-the-bulk-import-from-github-feature.adoc │ ├── procedure-importing-multiple-repositories-from-github.adoc │ ├── procedure-managing-the-imported-repository-list.adoc │ └── procedure-understanding-bulk-import-audit-logs.adoc ├── installation │ ├── con-airgapped-environment.adoc │ ├── proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc │ ├── proc-deploy-rhdh-instance-eks.adoc │ ├── proc-deploy-rhdh-instance-gke.adoc │ ├── proc-enable-signin.adoc │ ├── proc-install-operator.adoc │ ├── proc-install-rhdh-airgapped-full-k8s-helm.adoc │ ├── proc-install-rhdh-airgapped-partial-k8s-helm.adoc │ ├── proc-install-rhdh-helm-airgapped-full.adoc │ ├── proc-install-rhdh-helm-airgapped-partial.adoc │ ├── proc-install-rhdh-ocp-helm-cli.adoc │ ├── proc-install-rhdh-ocp-helm-gui.adoc │ ├── proc-install-rhdh-ocp-operator.adoc │ ├── proc-install-rhdh-operator-airgapped-full.adoc │ ├── proc-install-rhdh-operator-airgapped-partial.adoc │ ├── proc-install-rhdh-osd-gcp-helm.adoc │ ├── proc-install-rhdh-osd-gcp-operator.adoc │ ├── proc-rhdh-deploy-aks-helm.adoc │ ├── proc-rhdh-deploy-aks-operator.adoc │ ├── proc-rhdh-deploy-eks-helm.adoc │ ├── proc-rhdh-deploy-eks-operator.adoc │ ├── proc-rhdh-deploy-gke-helm.adoc │ └── proc-rhdh-deploy-gke-operator.adoc ├── observe │ ├── adoption-insights │ │ ├── con-about-adoption-insights.adoc │ │ ├── proc-configure-adoption-insights.adoc │ │ ├── proc-filter-records-to-display-spec.adoc │ │ ├── proc-install-adoption-insights.adoc │ │ ├── proc-modify-number-of-displayed-records.adoc │ │ ├── proc-setting-duration-of-data-metrics.adoc │ │ ├── proc-using-adoption-insights.adoc │ │ ├── proc-viewing-adoption-insights-card.adoc │ │ └── proc-viewing-searches.adoc │ ├── con-audit-log-config.adoc │ ├── con-audit-log-track-changes-catalog.adoc │ ├── proc-admin-enabling-metrics-ocp-helm.adoc │ ├── proc-admin-enabling-metrics-ocp-operator.adoc │ ├── proc-audit-log-view.adoc │ ├── proc-configure-annotations-for-aks-monitoring.adoc │ ├── proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-helm-chart.adoc │ ├── proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-operator.adoc │ ├── proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-helm-chart.adoc │ ├── proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-operator.adoc │ ├── proc-enabling-azure-monitor-metrics.adoc │ ├── proc-forward-audit-log-splunk.adoc │ ├── proc-retrieving-logs-from-amazon-cloudwatch.adoc │ └── proc-view-logs-aks.adoc ├── proc-create-plugin.adoc ├── release-notes │ ├── README.adoc │ ├── ref-release-notes-breaking-changes.adoc │ ├── ref-release-notes-deprecated-functionalities.adoc │ ├── ref-release-notes-fixed-issues.adoc │ ├── ref-release-notes-fixed-security-issues.adoc │ ├── ref-release-notes-known-issues.adoc │ ├── ref-release-notes-new-features.adoc │ ├── ref-release-notes-technology-preview.adoc │ ├── single-source-release-notes-template.adoc.jinja │ ├── single-source-release-notes.jira2asciidoc.yml │ └── single-source-release-notes.py ├── software-catalogs │ ├── proc-adding-new-components-to-the-rhdh-instance.adoc │ ├── proc-creating-new-components-in-the-rhdh-instance.adoc │ ├── proc-registering-components-manually-in-the-rhdh-instance.adoc │ ├── proc-searching-and-filter-software-catalogs.adoc │ ├── proc-starring-components-in-the-software-catalog.adoc │ ├── proc-updating-components-in-the-software-catalog.adoc │ └── proc-viewing-software-catalog-yaml.adoc ├── techdocs │ ├── con-techdocs-about.adoc │ ├── proc-techdocs-add-docs-from-remote-repo.adoc │ ├── proc-techdocs-addon-create.adoc │ ├── proc-techdocs-addon-install-helm.adoc │ ├── proc-techdocs-addon-install-operator.adoc │ ├── proc-techdocs-addon-install-third-party.adoc │ ├── proc-techdocs-addon-remove-helm.adoc │ ├── proc-techdocs-addon-remove-operator.adoc │ ├── proc-techdocs-addon-use-light-box.adoc │ ├── proc-techdocs-addon-use-report-issue.adoc │ ├── proc-techdocs-addon-use-text-size.adoc │ ├── proc-techdocs-edit-docs.adoc │ ├── proc-techdocs-find-docs.adoc │ └── proc-techdocs-view-docs.adoc ├── upgrade │ ├── proc-upgrade-rhdh-helm.adoc │ └── proc-upgrade-rhdh-operator.adoc ├── using-kubernetes-custom-actions │ ├── proc-enable-kubernetes-custom-actions-plugin.adoc │ ├── proc-using-kubernetes-custom-actions-plugin.adoc │ ├── ref-creating-a-template-using-kubernetes-custom-actions.adoc │ └── ref-supported-kubernetes-custom-actions.adoc └── using-service-now │ ├── proc-enable-servicenow-custom-actions-plugin.adoc │ └── ref-supported-servicenow-custom-actions.adoc ├── requirements.txt └── titles ├── about ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── adoption-insights ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── audit-log ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── authentication ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── authorization ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── configuring ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── customizing ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── install-rhdh-air-gapped ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── install-rhdh-aks ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── install-rhdh-eks ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── install-rhdh-gke ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── install-rhdh-ocp ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── install-rhdh-osd-gcp ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── monitoring-and-logging ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── plugin-rhdh ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc ├── modules └── title-plugin.adoc ├── plugins-rhdh-about ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── plugins-rhdh-configure ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── plugins-rhdh-install ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── plugins-rhdh-reference ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── plugins-rhdh-troubleshooting ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── plugins-rhdh-using ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── rel-notes-rhdh ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc ├── modules └── title-rhdh-release-notes.adoc ├── techdocs ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules ├── telemetry ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules └── upgrade-rhdh ├── artifacts ├── assemblies ├── docinfo.xml ├── images ├── master.adoc └── modules /.asciidoctor/docinfo-footer.html: -------------------------------------------------------------------------------- 1 | 10 | -------------------------------------------------------------------------------- /.asciidoctor/docinfo.html: -------------------------------------------------------------------------------- 1 |
2 | 9 |
10 | -------------------------------------------------------------------------------- /.asciidoctorconfig: -------------------------------------------------------------------------------- 1 | // .asciidoctorconfig 2 | // Specifies Asciidoctor configuration to preview files in the editor 3 | // See: https://intellij-asciidoc-plugin.ahus1.de/docs/users-guide/features/advanced/asciidoctorconfig-file.html 4 | 5 | // Set up attributes 6 | include::{asciidoctorconfigdir}/artifacts/attributes.adoc[] 7 | 8 | // Set up preview style 9 | :chapter-signifier: Chapter 10 | :docinfo: shared 11 | :docinfodir: {asciidoctorconfigdir}/.asciidoctor 12 | :sectnumlevels: 5 13 | :sectnums: 14 | :source-highlighter: coderay 15 | :stylesdir: {asciidoctorconfigdir}/.asciidoctor 16 | :stylesheet: docs.css 17 | :toc: left 18 | :toclevels: 5 19 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # .editorconfig 2 | # Specifies editor configuration 3 | # See: https://editorconfig.org/ 4 | root = true 5 | 6 | [*] 7 | charset = utf-8 8 | end_of_line = lf 9 | indent_size = 2 10 | indent_style = space 11 | insert_final_newline = true 12 | max_line_length = 120 13 | tab_width = 2 14 | trim_trailing_whitespace = true 15 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | **IMPORTANT: Do Not Merge - To be merged by Docs Team Only** 9 | 10 | **Version(s):** 11 | 12 | **Issue:** 13 | 14 | **Preview:** 15 | 16 | -------------------------------------------------------------------------------- /.github/workflows/style-guide.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Verify style guide compliance on pull request 3 | on: [pull_request] 4 | 5 | jobs: 6 | vale: 7 | name: Linting with Vale 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout 11 | uses: actions/checkout@v4 12 | - name: Install Asciidoctor 13 | run: sudo apt-get install -y asciidoctor 14 | - name: Run Vale on new and modified content 15 | uses: errata-ai/vale-action@v2.1.1 16 | with: 17 | files: assemblies 18 | vale_flags: "--minAlertLevel=warning" 19 | reporter: github-pr-review 20 | env: 21 | GITHUB_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }} 22 | REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }} 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | titles/*/build 3 | index.html 4 | titles-generated/ 5 | .vale-styles/RedHat 6 | .vscode 7 | .cache/ 8 | .vscode/ 9 | -------------------------------------------------------------------------------- /.htmltest.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # .htmltest.yml 3 | # Defines htmltest configuration 4 | # See: https://github.com/wjdp/htmltest 5 | # 6 | DirectoryPath: titles-generated/main 7 | CheckDoctype: false 8 | ExternalTimeout: 30 9 | OutputDir: .cache/htmltest 10 | IgnoreDirectoryMissingTrailingSlash: true 11 | IgnoreSSLVerify: true 12 | IgnoreURLs: # List URLS that are not published, false positives, websites refusing crawlers 13 | - https://docs.github.com/ 14 | -------------------------------------------------------------------------------- /.prettierrc.yml: -------------------------------------------------------------------------------- 1 | semi: false 2 | singleQuote: true 3 | tabWidth: 2 4 | trailingComma: es5 5 | options: 6 | editorconfig: true 7 | -------------------------------------------------------------------------------- /.sync/sync-manual-trigger.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/.sync/sync-manual-trigger.png -------------------------------------------------------------------------------- /.vale-styles/DeveloperHub/Attributes.yml: -------------------------------------------------------------------------------- 1 | --- 2 | extends: substitution 3 | ignorecase: false 4 | level: error 5 | message: Use the AsciiDoc attribute '{%s}' rather than '%s'. 6 | nonword: true 7 | scope: raw 8 | swap: 9 | '{product} Hub': product 10 | product Hub: product 11 | Backstage: product 12 | Developer Hub: product-short 13 | Hub Hub: product 14 | Red Hat Developer Hub: product 15 | Red Hat {product}: product 16 | -------------------------------------------------------------------------------- /.vale-styles/DeveloperHub/tests/.vale.ini: -------------------------------------------------------------------------------- 1 | ; .vale.ini 2 | ; Specifies Vale configuration 3 | ; See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/ 4 | ; 5 | ; Download and search Vale styles in this directory: 6 | StylesPath = ../.. 7 | ; Minimum alert level to display: 8 | MinAlertLevel = suggestion 9 | ; Display alerts on AsciiDoc files: 10 | [*.adoc] 11 | ; Apply these styles: 12 | BasedOnStyles = DeveloperHub 13 | -------------------------------------------------------------------------------- /.vale-styles/DeveloperHub/tests/fail.adoc: -------------------------------------------------------------------------------- 1 | Configure {product} Hub. 2 | Install product Hub. 3 | Configure Backstage. 4 | Install Developer Hub. 5 | Configure Red Hat Developer Hub Hub. 6 | Install Red Hat Developer Hub. 7 | Configure Red Hat {product}. 8 | -------------------------------------------------------------------------------- /.vale-styles/DeveloperHub/tests/pass.adoc: -------------------------------------------------------------------------------- 1 | {product} 2 | {product-short} 3 | backstage 4 | developer hub 5 | -------------------------------------------------------------------------------- /.vale.ini: -------------------------------------------------------------------------------- 1 | # .vale.ini 2 | # Specifies Vale configuration 3 | # See: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/ 4 | # 5 | 6 | # Download and search Vale styles in this directory: 7 | StylesPath = ".vale-styles" 8 | 9 | # Minimum alert level to display: 10 | MinAlertLevel = suggestion 11 | 12 | # Styles to download: 13 | Packages = RedHat 14 | 15 | # Display alerts on AsciiDoc files: 16 | [*.adoc] 17 | # Apply these styles: 18 | BasedOnStyles = RedHat,DeveloperHub 19 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "cSpell.words": [ 3 | "preconfigured" 4 | ] 5 | } -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## Contributing 2 | 3 | ### Certificate of Origin 4 | 5 | By contributing to this project you agree to the Developer Certificate of 6 | Origin (DCO). This document was created by the Linux Kernel community and is a 7 | simple statement that you, as a contributor, have the legal right to make the 8 | contribution. See the [DCO](DCO) file for details. 9 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | # Red Hat Developer Hub documentation 2 | 3 | This repo is the upstream mirror of https://gitlab.cee.redhat.com/red-hat-developers-documentation/rhdh 4 | 5 | Contribute to this repo and merged changes will be synced to gitlab for build with Pantheon. 6 | 7 | ## Building locally 8 | 9 | . Install `asciidoctor` - see https://docs.asciidoctor.org/asciidoctor/latest/install/linux-packaging/ 10 | . Run `build/scripts/build.sh` to generate html with images in titles-generated/ folders 11 | 12 | ## Previews 13 | 14 | Commits to this repo can be seen as GH Page content here: 15 | 16 | https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/ 17 | 18 | Pull requests will have a link to the generated HTML attached a comment. 19 | 20 | ## Contributing 21 | 22 | Submit a pull request against this repo. 23 | 24 | 25 | ## Plugins Reference Guide 26 | For Plugin configuration guide, see upstream content in https://github.com/janus-idp/backstage-plugins/tree/main/plugins 27 | -------------------------------------------------------------------------------- /artifacts/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/aap-backend/aap-backend-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | .Installation 2 | The AAP backend plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows: 3 | 4 | [source,yaml] 5 | ---- 6 | global: 7 | dynamic: 8 | includes: 9 | - dynamic-plugins.default.yaml 10 | plugins: 11 | - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic 12 | disabled: false 13 | ---- 14 | 15 | .Basic configuration 16 | To enable the AAP plugin, you must set the following environment variables: 17 | 18 | * `AAP_BASE_URL` 19 | 20 | * `AAP AUTH TOKEN` 21 | 22 | .Advanced configuration -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/acr/acr-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | .Installation 2 | The ACR plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows: 3 | 4 | [source,yaml] 5 | ---- 6 | global: 7 | dynamic: 8 | includes: 9 | - dynamic-plugins.default.yaml 10 | plugins: 11 | - package: ./dynamic-plugins/dist/backstage-community-plugin-acr 12 | disabled: false 13 | ---- 14 | 15 | .Configuration -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/attributes.adoc: -------------------------------------------------------------------------------- 1 | ../../artifacts/attributes.adoc -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/images: -------------------------------------------------------------------------------- 1 | ../../images/rhdh-plugins-reference/ -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | .Procedure 2 | {product-short} dynamically installs the Jfrog Artifactory plugin. To enable it, set the `disabled` property to `false` as follows: 3 | 4 | [source,yaml] 5 | ---- 6 | global: 7 | dynamic: 8 | includes: 9 | - dynamic-plugins.default.yaml 10 | plugins: 11 | - package: ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory 12 | disabled: false 13 | ---- 14 | 15 | .Configuration -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-keycloak_{context}"] 2 | = Using Keycloak 3 | 4 | The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities: 5 | 6 | * Synchronization of Keycloak users in a realm. 7 | * Synchronization of Keycloak groups and their users in a realm. 8 | 9 | == Importing users and groups in {product-short} using the Keycloak plugin 10 | 11 | After configuring the plugin successfully, the plugin imports the users and groups each time when started. 12 | 13 | [NOTE] 14 | ==== 15 | If you set up a schedule, users and groups will also be imported. 16 | ==== 17 | 18 | .Procedure 19 | . in {product}, go to the *Catalog* page. 20 | . Select *User* from the entity type filter to display the list of imported users. 21 | . Browse the list of users displayed on the page. 22 | . Select a user to view detailed information imported from Keycloak. 23 | . To view groups, select *Group* from the entity type filter. 24 | . Browse the list of groups shown on the page. 25 | . From the list of groups, select a group to view the information imported from Keycloak. 26 | -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | The Nexus Repository Manager plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the disabled property to false as follows: 2 | 3 | [source,yaml] 4 | ---- 5 | global: 6 | dynamic: 7 | includes: 8 | - dynamic-plugins.default.yaml 9 | plugins: 10 | - package: ./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager 11 | disabled: false 12 | ---- 13 | 14 | .Configuration -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/ocm/ocm-backend-plugin-readme.adoc: -------------------------------------------------------------------------------- 1 | = Open Cluster Management plugin for Backstage 2 | 3 | The Open Cluster Management (OCM) plugin integrates your Backstage instance with OCM. 4 | 5 | For more information about OCM plugin, see the https://github.com/backstage/community-plugins/tree/main/workspaces/ocm/plugins/ocm[Open Cluster Management plugin documentation] on GitHub. 6 | -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/ocm/ocm-common-plugin-readme.adoc: -------------------------------------------------------------------------------- 1 | = Open Cluster Management plugin for Backstage 2 | 3 | The Open Cluster Management (OCM) plugin integrates your Backstage instance with OCM. 4 | 5 | For more information about OCM plugin, see the https://github.com/backstage/community-plugins/tree/main/workspaces/ocm/plugins/ocm[Open Cluster Management plugin documentation] on GitHub. 6 | -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/quay/quay-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | .Installation 2 | The Quay plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows: 3 | 4 | [source,yaml] 5 | ---- 6 | global: 7 | dynamic: 8 | includes: 9 | - dynamic-plugins.default.yaml 10 | plugins: 11 | - package: ./dynamic-plugins/dist/backstage-community-plugin-quay 12 | disabled: false 13 | ---- 14 | 15 | .Configuration -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/snip-concious-language.adoc: -------------------------------------------------------------------------------- 1 | ../../artifacts/snip-conscious-language.adoc -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/tekton/tekton-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | .Installation 2 | {product-short} dynamically installs the Tekton plugin. To enable it, set the `disabled` property to `false` as follows: 3 | 4 | [source,yaml] 5 | ---- 6 | global: 7 | dynamic: 8 | includes: 9 | - dynamic-plugins.default.yaml 10 | plugins: 11 | - package: ./dynamic-plugins/dist/backstage-community-plugin-tekton 12 | disabled: false 13 | ---- 14 | -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/topology/topology-install-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | .Installation 2 | The Topology plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows: 3 | 4 | [source,yaml] 5 | ---- 6 | global: 7 | dynamic: 8 | includes: 9 | - dynamic-plugins.default.yaml 10 | plugins: 11 | - package: ./dynamic-plugins/dist/backstage-community-plugin-topology 12 | disabled: false 13 | ---- 14 | 15 | .Configuration -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/topology/topology-plugin-admin.adoc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/artifacts/rhdh-plugins-reference/topology/topology-plugin-admin.adoc -------------------------------------------------------------------------------- /artifacts/rhdh-plugins-reference/topology/topology-plugin-user.adoc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/artifacts/rhdh-plugins-reference/topology/topology-plugin-user.adoc -------------------------------------------------------------------------------- /artifacts/snip-conscious-language.adoc: -------------------------------------------------------------------------------- 1 | [preface] 2 | [id='snip-conscious-language_{context}'] 3 | = Making open source more inclusive 4 | 5 | Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[_our CTO Chris Wright's message_]. 6 | -------------------------------------------------------------------------------- /artifacts/snip-developer-preview.adoc: -------------------------------------------------------------------------------- 1 | [IMPORTANT] 2 | ==== 3 | This section describes Developer Preview features in the Adoption Insights plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA. 4 | 5 | For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope]. 6 | ==== 7 | -------------------------------------------------------------------------------- /artifacts/snip-dynamic-plugins-support.adoc: -------------------------------------------------------------------------------- 1 | [id='snip-dynamic-plugins-support_{context}'] 2 | 3 | = Technology Preview plugins 4 | 5 | [IMPORTANT] 6 | ==== 7 | {product} includes a select number of Technology Preview plugins, available for customers to configure and enable. These plugins are provided with support scoped per Technical Preview terms, might not be functionally complete, and {company-name} does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. 8 | 9 | For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope]. 10 | 11 | // Additional details on how Red Hat provides support for bundled community dynamic plugins are available on the https://access.redhat.com/policy/developerhub-support-policy[Red Hat Developer Support Policy] page. 12 | ==== 13 | -------------------------------------------------------------------------------- /artifacts/snip-technology-preview.adoc: -------------------------------------------------------------------------------- 1 | [IMPORTANT] 2 | ==== 3 | These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. 4 | 5 | For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope]. 6 | ==== 7 | -------------------------------------------------------------------------------- /assemblies/assembly-authenticating-with-github.adoc: -------------------------------------------------------------------------------- 1 | [id="authenticating-with-github"] 2 | = Authenticating with GitHub 3 | 4 | To authenticate users with GitHub or GitHub Enterprise: 5 | 6 | . xref:enabling-authentication-with-github[Enable the GitHub authentication provider in {product-short}]. 7 | . xref:provisioning-users-from-github-to-the-software-catalog[Provision users from GitHub to the software catalog]. 8 | 9 | include::modules/authentication/proc-enabling-authentication-with-github.adoc[leveloffset=+1] 10 | 11 | 12 | include::modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc[leveloffset=+1] 13 | 14 | -------------------------------------------------------------------------------- /assemblies/assembly-authenticating-with-microsoft-azure.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-authenticating-with-microsoft-azure"] 2 | = Authentication with Microsoft Azure 3 | 4 | To authenticate users with Microsoft Azure: 5 | 6 | . xref:enabling-authentication-with-microsoft-azure[Enable authentication with Microsoft Azure]. 7 | . xref:provisioning-users-from-microsoft-azure-to-the-software-catalog[Provision users from Microsoft Azure to the software catalog]. 8 | 9 | include::modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc[leveloffset=+1] 10 | 11 | 12 | include::modules/authentication/proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc[leveloffset=+1] 13 | 14 | -------------------------------------------------------------------------------- /assemblies/assembly-authenticating-with-rhbk.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-authenticating-with-rhbk"] 2 | = Authenticating with {rhbk-brand-name} ({rhbk}) 3 | 4 | To authenticate users with {rhbk-brand-name} ({rhbk}): 5 | 6 | . xref:enabling-authentication-with-rhbk[Enable the OpenID Connect (OIDC) authentication provider in RHDH]. 7 | . xref:provisioning-users-from-rhbk-to-the-software-catalog[Provision users from {rhbk-brand-name} ({rhbk}) to the software catalog]. 8 | 9 | include::modules/authentication/proc-enabling-authentication-with-rhbk.adoc[leveloffset=+1] 10 | 11 | include::modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+1] 12 | 13 | include::modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+1] 14 | -------------------------------------------------------------------------------- /assemblies/assembly-authenticating-with-the-guest-user.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="authenticating-with-the-guest-user_{context}"] 3 | = Authenticating with the Guest user 4 | 5 | To explore {product-short} features, you can skip configuring authentication and authorization. 6 | You can configure {product-short} to log in as a Guest user and access {product-short} features. 7 | 8 | include::modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc[leveloffset=+1] 9 | 10 | 11 | include::modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc[leveloffset=+1] 12 | 13 | -------------------------------------------------------------------------------- /assemblies/assembly-bulk-importing-from-github.adoc: -------------------------------------------------------------------------------- 1 | [id="bulk-importing-github-repositories"] 2 | = Bulk importing GitHub repositories 3 | 4 | include::{docdir}/artifacts/snip-technology-preview.adoc[] 5 | 6 | {product} can automate GitHub repositories onboarding and track their import status. 7 | 8 | include::modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc[leveloffset=+1] 9 | 10 | include::modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc[leveloffset=+1] 11 | 12 | include::modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc[leveloffset=+1] 13 | 14 | include::modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc[leveloffset=+1] 15 | 16 | -------------------------------------------------------------------------------- /assemblies/assembly-configuring-a-floating-action-button.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: configuring-a-floating-action-button 3 | [id="{context}"] 4 | = Configuring a floating action button in {product} 5 | 6 | You can use the floating action button plugin to configure any action as a floating button in the {product-short} instance. The floating action button plugin is enabled by default. You can also configure floating action buttons to display as submenu options within the main floating action button by assigning the floating action buttons to the same `slot` field of your `dynamic-plugins.yaml` file. 7 | 8 | include::modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc[leveloffset=+1] 9 | 10 | include::modules/configuring-a-floating-action-button/ref-floating-action-button-parameters.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-configuring-a-proxy.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: running-behind-a-proxy 3 | [id="{context}"] 4 | = Running {product} behind a corporate proxy 5 | 6 | In a network restricted environment, configure {product} to use your proxy to access remote network resources. 7 | 8 | You can run the {product-short} application behind a corporate proxy by setting any of the following environment variables before starting the application: 9 | 10 | `HTTP_PROXY`:: Denotes the proxy to use for HTTP requests. 11 | `HTTPS_PROXY`:: Denotes the proxy to use for HTTPS requests. 12 | 13 | `NO_PROXY`:: Set the environment variable to bypass the proxy for certain domains. The variable value is a comma-separated list of hostnames or IP addresses that can be accessed without the proxy, even if one is specified. 14 | 15 | 16 | include::modules/configuring-a-proxy/con-understanding-the-no_proxy-exclusion-rules.adoc[leveloffset=+1] 17 | 18 | 19 | include::modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1] 20 | 21 | 22 | include::modules/configuring-a-proxy/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1] 23 | 24 | -------------------------------------------------------------------------------- /assemblies/assembly-configuring-default-secret-pvc-mounts.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-configuring-default-secret-pvc-mounts_{context}"] 3 | = Configuring default mounts for Secrets and PVCs 4 | 5 | You can configure Persistent Volume Claims (PVCs) and Secrets mount in your {product} deployment. Use annotations to define the custom mount paths and specify the containers to mount them to. 6 | 7 | include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+1] 8 | 9 | include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-configuring-guest-access-with-rbac-ui.adoc: -------------------------------------------------------------------------------- 1 | [id="configuring-guest-access-with-rbac-ui_{context}"] 2 | = Configuring guest access with RBAC UI 3 | 4 | Use guest access with the role-based access control (RBAC) front-end plugin to allow a user to test role and policy creation without the need to set up and configure an authentication provider. 5 | 6 | [NOTE] 7 | ==== 8 | Guest access is not recommended for production. 9 | ==== 10 | 11 | include::modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc[leveloffset=+1] 12 | 13 | include::modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc[leveloffset=+1] 14 | -------------------------------------------------------------------------------- /assemblies/assembly-configuring-readonlyrootfilesystem.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: readonlyrootfilesystem 3 | [id="{context}"] 4 | = Configuring readOnlyRootFilesystem in {product} 5 | 6 | The {product} deployment consists of two containers: an `initContainer` that installs the Dynamic Plugins, and a backend container that runs the application. The `initContainer` has the `readOnlyRootFilesystem` option enabled by default. To enable this option on the backend container, you must either have permission to deploy resources through Helm or to create or update a CR for Operator-backed deployments. You can manually configure the `readOnlyRootFilesystem` option on the backend container by using the following methods: 7 | 8 | * The {product} Operator 9 | * The {product} Helm chart 10 | 11 | include::modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-operator-deployment.adoc[leveloffset=+1] 12 | 13 | include::modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-customizing-segment-source.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="customizing-segment-source_{context}"] 3 | = Customizing Segment source 4 | 5 | The `analytics-provider-segment` plugin sends the collected web analytics data to {company-name} by default. However, you can configure a new Segment source that receives web analytics data based on your needs. For configuration, you need a unique Segment write key that points to the Segment source. 6 | 7 | [NOTE] 8 | ==== 9 | Create your own web analytics data collection notice for your application users. 10 | ==== 11 | 12 | include::modules/analytics/proc-customizing-segment-source-using-the-operator.adoc[leveloffset=+1] 13 | 14 | include::modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc[leveloffset=+1] 15 | 16 | .Additional resources 17 | * To learn how to collect and analyze the same set of data, see link:{telemetry-data-collection-book-url}[{telemetry-data-collection-book-title}]. -------------------------------------------------------------------------------- /assemblies/assembly-customizing-the-homepage.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: customizing-the-home-page 3 | [id="{context}"] 4 | = Customizing the Home page 5 | 6 | When using the `app-config`, you can do the following: 7 | 8 | * Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled. 9 | * Change quick access links. 10 | * Add, reorganize, and remove the following available cards: 11 | + 12 | ** Search bar 13 | ** Quick access 14 | ** Headline 15 | ** Markdown 16 | ** Placeholder 17 | ** Catalog starred entities 18 | ** Featured docs 19 | 20 | include::modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc[leveloffset=+1] 21 | 22 | 23 | include::modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1] 24 | 25 | -------------------------------------------------------------------------------- /assemblies/assembly-customizing-the-learning-paths.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-customize-rhdh-learning-paths_{context}'] 2 | = Customizing the Learning Paths in {product} 3 | 4 | In {product}, you can configure Learning Paths by hosting the required data externally, 5 | and using the built-in proxy to deliver this data rather than the default. 6 | 7 | You can provide Learning Paths data from the following sources: 8 | 9 | * A JSON file hosted on a web server, such as GitHub or GitLab. 10 | * A dedicated service that provides the Learning Paths data in JSON format using an API. 11 | 12 | include::modules/customizing-the-learning-paths/con-about-learning-paths.adoc[leveloffset=+1] 13 | 14 | 15 | include::modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc[leveloffset=+1] 16 | 17 | 18 | include::modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc[leveloffset=+1] 19 | 20 | 21 | include::modules/customizing-the-learning-paths/proc-starting-and-completing-lessions-in-learning-paths.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-customizing-the-quick-access-card.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: customizing-the-quick-access-card 3 | [id="{context}"] 4 | = Customizing the Quick access card 5 | 6 | To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources: 7 | 8 | * JSON files hosted on GitHub or GitLab. 9 | * A dedicated service that provides the Home page data in JSON format using an API. 10 | 11 | include::modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1] 12 | 13 | 14 | include::modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1] 15 | 16 | -------------------------------------------------------------------------------- /assemblies/assembly-disabling-telemetry-data-collection.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="disabling-telemetry-data-collection_{context}"] 3 | = Disabling telemetry data collection in {product-very-short} 4 | 5 | To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration. 6 | 7 | As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the {product-very-short} application. For more details, see the link:{telemetry-data-collection-book-url}#proc-disabling-telemetry-using-operator_title-telemetry[Disabling telemetry data collection in {product-very-short}] section. 8 | 9 | include::modules/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+1] 10 | 11 | include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-enabling-telemetry-data-collection.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="enabling-telemetry-data-collection_{context}"] 3 | = Enabling telemetry data collection in {product-very-short} 4 | 5 | The telemetry data collection feature is enabled by default. However, if you have disabled the feature and want to re-enable it, you must enable the `analytics-provider-segment` plugin either by using the Helm Chart or the {product} Operator configuration. 6 | 7 | include::modules/analytics/proc-enabling-telemetry-using-operator.adoc[leveloffset=+1] 8 | 9 | include::modules/analytics/proc-enabling-telemetry-using-helm.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-install-rhdh-airgapped-environment-ocp-helm_{context}"] 2 | = Installing {product} on {ocp-short} in an air-gapped environment with the Helm chart 3 | 4 | You can install {product} in a fully disconnected or partially disconnected environment using the {product} Helm chart. 5 | 6 | [role="_additional-resources"] 7 | .Additional resources 8 | * For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. 9 | 10 | include::modules/installation/proc-install-rhdh-helm-airgapped-full.adoc[leveloffset=+1] 11 | 12 | include::modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-install-rhdh-airgapped-environment-ocp-operator.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-install-rhdh-airgapped-environment-ocp-operator_{context}"] 3 | = Installing {product} in an air-gapped environment with the Operator 4 | 5 | You can install {product} in a fully disconnected or partially disconnected environment using the {product} Operator. For a list of supported platforms, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle page]. 6 | 7 | include::modules/installation/proc-install-rhdh-operator-airgapped-full.adoc[leveloffset=+1] 8 | 9 | include::modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-install-rhdh-eks-operator.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-install-rhdh-eks-operator"] 3 | = Installing {product-short} on {eks-short} with the Operator 4 | 5 | The {product} Operator installation requires the Operator Lifecycle Manager (OLM) framework. 6 | 7 | .Additional resources 8 | * For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation. 9 | 10 | include::modules/installation/proc-rhdh-deploy-eks-operator.adoc[leveloffset=+1] 11 | -------------------------------------------------------------------------------- /assemblies/assembly-install-rhdh-ocp-helm.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-install-rhdh-ocp-helm"] 3 | = Installing {product} on {ocp-short} with the Helm chart 4 | :context: assembly-install-rhdh-ocp-helm 5 | 6 | You can install {product} on {ocp-short} by using the Helm chart with one of the following methods: 7 | 8 | * The {ocp-short} console 9 | * The Helm CLI 10 | 11 | include::modules/installation/proc-install-rhdh-ocp-helm-gui.adoc[leveloffset=+1] 12 | 13 | include::modules/installation/proc-install-rhdh-ocp-helm-cli.adoc[leveloffset=+1] 14 | -------------------------------------------------------------------------------- /assemblies/assembly-install-rhdh-ocp-operator.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-install-rhdh-ocp-operator"] 3 | = Installing {product} on {ocp-short} with the Operator 4 | :context: assembly-install-rhdh-ocp-operator 5 | 6 | You can install {product} on {ocp-short} by using the {product} Operator in the {ocp-short} console. 7 | 8 | include::modules/installation/proc-install-operator.adoc[leveloffset=+1] 9 | 10 | include::modules/installation/proc-install-rhdh-ocp-operator.adoc[leveloffset=+1] 11 | -------------------------------------------------------------------------------- /assemblies/assembly-install-rhdh-osd-gcp.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-install-rhdh-osd-gcp"] 2 | = Installing {product} on {osd-short} on {gcp-brand-name} 3 | :context: assembly-install-rhdh-osd-gcp 4 | 5 | You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using one of the following methods: 6 | 7 | * The {product} Operator 8 | * The {product} Helm chart 9 | 10 | // Operator procedure 11 | include::modules/installation/proc-install-rhdh-osd-gcp-operator.adoc[leveloffset=+1] 12 | 13 | // Helm procedure 14 | include::modules/installation/proc-install-rhdh-osd-gcp-helm.adoc[leveloffset=+1] 15 | 16 | -------------------------------------------------------------------------------- /assemblies/assembly-logging-with-amazon-cloudwatch.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-logging-with-amazon-cloudwatch_{context}"] 2 | = Logging with Amazon CloudWatch 3 | 4 | Logging within the {product} relies on the link:https://github.com/winstonjs/winston[Winston library]. 5 | The default logging level is `info`. 6 | To have more detailed logs, set the `LOG_LEVEL` environment variable to `debug` in your {product} instance. 7 | 8 | 9 | include::modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-operator.adoc[leveloffset=+1] 10 | 11 | 12 | include::modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-helm-chart.adoc[leveloffset=+1] 13 | 14 | 15 | include::modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc[leveloffset=+1] 16 | 17 | -------------------------------------------------------------------------------- /assemblies/assembly-managing-authorizations-by-using-external-files.adoc: -------------------------------------------------------------------------------- 1 | [id='managing-authorizations-by-using-external-files'] 2 | = Managing authorizations by using external files 3 | 4 | To automate {product} maintenance, you can configure permissions and roles in external files, before starting {product-short}. 5 | 6 | 7 | include::modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc[leveloffset=+1] 8 | 9 | include::modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc[leveloffset=+1] 10 | 11 | -------------------------------------------------------------------------------- /assemblies/assembly-managing-authorizations-by-using-the-rest-api.adoc: -------------------------------------------------------------------------------- 1 | [id='managing-authorizations-by-using-the-rest-api'] 2 | = Managing authorizations by using the REST API 3 | 4 | To automate the maintenance of {product} permission policies and roles, you can use {product-short} role-based access control (RBAC) REST API. 5 | 6 | You can perform the following actions with the REST API: 7 | 8 | * Retrieve information about: 9 | ** All permission policies 10 | ** Specific permission policies 11 | ** Specific roles 12 | ** Static plugins permission policies 13 | * Create, update, or delete: 14 | ** Permission policy 15 | ** Role 16 | 17 | 18 | include::modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc[leveloffset=+1] 19 | 20 | 21 | include::modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-a-rest-client.adoc[leveloffset=+1] 22 | 23 | 24 | include::modules/authorization/ref-rbac-rest-api-endpoints.adoc[leveloffset=+1] 25 | 26 | -------------------------------------------------------------------------------- /assemblies/assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc: -------------------------------------------------------------------------------- 1 | [id='managing-authorizations-by-using-the-web-ui'] 2 | = Managing role-based access controls (RBAC) using the {product} Web UI 3 | 4 | Policy administrators can use the {product-short} web interface (Web UI) to allocate specific roles and permissions to individual users or groups. Allocating roles ensures that access to resources and functionalities is regulated across the {product-short}. 5 | 6 | With the policy administrator role in {product-short}, you can assign permissions to users and groups. This role allows you to view, create, modify, and delete the roles using {product-short} Web UI. 7 | 8 | 9 | include::modules/authorization/proc-rbac-ui-create-role.adoc[leveloffset=+1] 10 | 11 | 12 | include::modules/authorization/proc-rbac-ui-edit-role.adoc[leveloffset=+1] 13 | 14 | 15 | include::modules/authorization/proc-rbac-ui-delete-role.adoc[leveloffset=+1] 16 | -------------------------------------------------------------------------------- /assemblies/assembly-managing-labels-annotations-topology.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-managing-labels-annotations-topology"] 3 | = Managing labels and annotations for Topology plugins 4 | :context: assembly-managing-labels-annotations-topology 5 | 6 | include::modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc[leveloffset=+1] 7 | 8 | include::modules/dynamic-plugins/proc-entity-annotation-or-label.adoc[leveloffset=+1] 9 | 10 | include::modules/dynamic-plugins/proc-namespace-annotation.adoc[leveloffset=+1] 11 | 12 | include::modules/dynamic-plugins/proc-label-selector-query-annotation.adoc[leveloffset=+1] 13 | 14 | include::modules/dynamic-plugins/proc-icon-displayed-in-the-node.adoc[leveloffset=+1] 15 | 16 | include::modules/dynamic-plugins/proc-app-grouping.adoc[leveloffset=+1] 17 | 18 | include::modules/dynamic-plugins/proc-node-connector.adoc[leveloffset=+1] 19 | 20 | For more information about the labels and annotations, see _Guidelines for labels and annotations for OpenShift applications_. -------------------------------------------------------------------------------- /assemblies/assembly-monitoring-and-logging-aks.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-monitoring-and-logging-aks"] 2 | = Monitoring and logging with Azure Kubernetes Services (AKS) in {product} 3 | :context: assembly-monitoring-and-logging-aks 4 | 5 | Monitoring and logging are integral aspects of managing and maintaining Azure Kubernetes Services (AKS) in {product}. With features like Managed Prometheus Monitoring and Azure Monitor integration, administrators can efficiently monitor resource utilization, diagnose issues, and ensure the reliability of their containerized workloads. 6 | 7 | // Azure monitor metrics 8 | include::modules/observe/proc-enabling-azure-monitor-metrics.adoc[leveloffset=+1] 9 | 10 | // configure annotations 11 | include::modules/observe/proc-configure-annotations-for-aks-monitoring.adoc[leveloffset=+1] 12 | 13 | // view logs 14 | include::modules/observe/proc-view-logs-aks.adoc[leveloffset=+1] 15 | 16 | -------------------------------------------------------------------------------- /assemblies/assembly-monitoring-and-logging-with-aws.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-monitoring-and-logging-with-aws_{context}"] 2 | = Monitoring and logging {product} on {aws-brand-name} ({aws-short}) 3 | 4 | You can configure {product} to use Amazon CloudWatch for real-time monitoring and Amazon Prometheus for comprehensive logging. 5 | This is convenient when hosting {product-short} on {aws-brand-name} ({aws-short}) infrastructure. 6 | 7 | include::assembly-monitoring-with-amazon-prometheus.adoc[leveloffset=+1] 8 | 9 | 10 | include::assembly-logging-with-amazon-cloudwatch.adoc[leveloffset=+1] 11 | 12 | -------------------------------------------------------------------------------- /assemblies/assembly-monitoring-with-amazon-prometheus.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-monitoring-with-amazon-prometheus_{context}"] 2 | = Monitoring with Amazon Prometheus 3 | 4 | You can configure {product} to use Amazon Prometheus for comprehensive logging. 5 | Amazon Prometheus extracts data from pods that have specific pod annotations. 6 | 7 | == Prerequisites 8 | 9 | * You link:https://docs.aws.amazon.com/eks/latest/userguide/prometheus.htm[configured Prometheus for your {eks-name} ({eks-short}) clusters]. 10 | * You link:https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html[created an Amazon managed service for the Prometheus workspace]. 11 | * You link:https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-ingest-metrics.html[configured Prometheus to import the {product-short} metrics]. 12 | * You ingested Prometheus metrics into the created workspace. 13 | 14 | 15 | include::modules/observe/proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-operator.adoc[leveloffset=+1] 16 | 17 | 18 | include::modules/observe/proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-helm-chart.adoc[leveloffset=+1] 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /assemblies/assembly-release-notes-known-issues.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: ASSEMBLY 2 | [id="known-issues"] 3 | = Known issues 4 | 5 | This section lists known issues in {product} {product-version}. 6 | 7 | 8 | include::modules/release-notes/snip-known-issue-rhidp-4378.adoc[leveloffset=+1] 9 | 10 | 11 | include::modules/release-notes/snip-known-issue-rhidp-4069.adoc[leveloffset=+1] 12 | 13 | 14 | include::modules/release-notes/snip-known-issue-rhidp-4067.adoc[leveloffset=+1] 15 | 16 | 17 | include::modules/release-notes/snip-known-issue-rhidp-3931.adoc[leveloffset=+1] 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /assemblies/assembly-rhdh-integration-aks.adoc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/assemblies/assembly-rhdh-integration-aks.adoc -------------------------------------------------------------------------------- /assemblies/assembly-rhdh-observability.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-rhdh-observability"] 3 | = Enabling observability for {product} on {ocp-short} 4 | :context: assembly-rhdh-observability 5 | 6 | // Metrics 7 | In {ocp-short}, metrics are exposed through an HTTP service endpoint under the `/metrics` canonical name. You can create a `ServiceMonitor` custom resource (CR) to scrape metrics from a service endpoint in a user-defined project. 8 | 9 | include::modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc[leveloffset=+1] 10 | include::modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc[leveloffset=+1] 11 | 12 | 13 | [role="_additional-resources"] 14 | .Additional resources 15 | * link:https://docs.openshift.com/container-platform/latest/observability/monitoring/managing-metrics.html[{ocp-short} - Managing metrics] 16 | -------------------------------------------------------------------------------- /assemblies/assembly-techdocs-add-docs.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: assembly-techdocs-add-docs 3 | [id="{context}"] 4 | = Adding documentation to TechDocs 5 | 6 | After an administrator configures the TechDocs plugin, a developer can add documentation to TechDocs by importing it from a remote repository. Any authorized user or group can access the documentation that is imported into the TechDocs plugin. 7 | 8 | include::modules/techdocs/proc-techdocs-add-docs-from-remote-repo.adoc[leveloffset=+1] 9 | -------------------------------------------------------------------------------- /assemblies/assembly-techdocs-addons-removing.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: techdocs-addon-removing 3 | [id="techdocs-addon-removing"] 4 | = Removing a TechDocs add-on 5 | 6 | Administrators can remove installed TechDocs add-ons from your {product} instance by using either the Operator or Helm chart, depending on the method used to install the add-on. If you used the Operator to install the add-on, remove it from the ConfigMap. If you used the Helm chart to install the add-on, remove it from the Helm chart. 7 | 8 | If you want to disable a plugin instead of removing it from your {product} instance, you can disable the plugin that you are using to import the TechDocs add-on. Since the `disabled` status is controlled at the plugin level, disabling the plugin disables all of the TechDocs add-ons in the specified plugin package. 9 | 10 | include::modules/techdocs/proc-techdocs-addon-remove-operator.adoc[] 11 | 12 | include::modules/techdocs/proc-techdocs-addon-remove-helm.adoc[] 13 | -------------------------------------------------------------------------------- /assemblies/assembly-techdocs-addons-using.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: techdocs-addon-using 3 | [id="techdocs-addon-using"] 4 | = Using TechDocs add-ons 5 | 6 | After an administrator installs a TechDocs add-on in your {product} instance, you can use it to extend the functionality of the TechDocs plugin and enhance your documentation experience. 7 | 8 | include::modules/techdocs/proc-techdocs-addon-use-report-issue.adoc[] 9 | 10 | include::modules/techdocs/proc-techdocs-addon-use-text-size.adoc[] 11 | 12 | include::modules/techdocs/proc-techdocs-addon-use-light-box.adoc[] 13 | -------------------------------------------------------------------------------- /assemblies/assembly-topology-plugin-configure.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-topology-plugin-configure"] 3 | = Configuring the Topology plugin 4 | :context: assembly-topology-plugin-configure 5 | 6 | include::modules/dynamic-plugins/proc-viewing-openshift-routes.adoc[leveloffset=+1] 7 | 8 | include::modules/dynamic-plugins/proc-viewing-pod-logs.adoc[leveloffset=+1] 9 | 10 | include::modules/dynamic-plugins/proc-viewing-tekton-pipelineruns.adoc[leveloffset=+1] 11 | 12 | include::modules/dynamic-plugins/proc-viewing-virtual-machines.adoc[leveloffset=+1] 13 | 14 | include::modules/dynamic-plugins/proc-enabling-the-source-code-editor.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/assembly-upgrade-rhdh.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | [id="assembly-upgrade-rhdh"] 3 | = Upgrading {product} 4 | :context: assembly-upgrade-rhdh 5 | 6 | toc::[] 7 | 8 | -------------------------------------------------------------------------------- /assemblies/assembly-using-kubernetes-custom-actions.adoc: -------------------------------------------------------------------------------- 1 | [id='con-Kubernetes-custom-actions_{context}'] 2 | = Kubernetes custom actions in {product} 3 | 4 | With Kubernetes custom actions, you can create and manage Kubernetes resources. 5 | 6 | The Kubernetes custom actions plugin is preinstalled and disabled on a {product-short} instance by default. You can disable or enable the Kubernetes custom actions plugin, and change other parameters, by configuring the {product} Helm chart. 7 | 8 | [NOTE] 9 | ==== 10 | Kubernetes scaffolder actions and Kubernetes custom actions refer to the same concept throughout this documentation. 11 | ==== 12 | 13 | 14 | include::modules/using-kubernetes-custom-actions/proc-enable-kubernetes-custom-actions-plugin.adoc[leveloffset=+1] 15 | 16 | include::modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc[leveloffset=+1] 17 | 18 | include::modules/using-kubernetes-custom-actions/ref-creating-a-template-using-kubernetes-custom-actions.adoc[leveloffset=+1] 19 | 20 | include::modules/using-kubernetes-custom-actions/ref-supported-kubernetes-custom-actions.adoc[leveloffset=+2] -------------------------------------------------------------------------------- /assemblies/assembly-using-servicenow.adoc: -------------------------------------------------------------------------------- 1 | [id='con-servicenow-custom-actions_{context}'] 2 | = ServiceNow Custom actions in {product} 3 | 4 | include::{docdir}/artifacts/snip-technology-preview.adoc[] 5 | 6 | In {product}, you can access ServiceNow custom actions (custom actions) for fetching and registering resources in the catalog. 7 | 8 | The custom actions in {product-short} enable you to facilitate and automate the management of records. Using the custom actions, you can perform the following actions: 9 | 10 | * Create, update, or delete a record 11 | * Retrieve information about a single record or multiple records 12 | 13 | include::modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc[leveloffset=+1] 14 | 15 | 16 | include::modules/using-service-now/ref-supported-servicenow-custom-actions.adoc[leveloffset=+1] 17 | 18 | -------------------------------------------------------------------------------- /assemblies/assembly-using-techdocs.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: assembly-using-techdocs 3 | [id="{context}"] 4 | = Using TechDocs 5 | 6 | The TechDocs plugin is installed and enabled on your {product} instance by default. After an administrator configures the TechDocs plugin, an authorized developer can use the TechDocs plugin to add, view, or manage documentation. 7 | 8 | include::assembly-techdocs-add-docs.adoc[leveloffset=+1] 9 | 10 | include::modules/techdocs/proc-techdocs-find-docs.adoc[leveloffset=+1] 11 | 12 | include::modules/techdocs/proc-techdocs-view-docs.adoc[leveloffset=+1] 13 | 14 | include::modules/techdocs/proc-techdocs-edit-docs.adoc[leveloffset=+1] 15 | -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-about-rhdh-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-about-rhdh-plugins_{context}"] 2 | = About {product} plugins 3 | 4 | include::../modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-configuring-rhdh-plugins_{context}"] 2 | = Configuring dynamic plugins in {product} 3 | 4 | // Ansible 5 | include::../modules/dynamic-plugins/con-ansible-plugin-admin.adoc[leveloffset=+1] 6 | 7 | // Argo CD 8 | include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc[leveloffset=+1] 9 | 10 | //JFrog Artifactory 11 | include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc[leveloffset=+1] 12 | 13 | // Keycloak 14 | include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc[leveloffset=+1] 15 | 16 | // Nexus 17 | include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-admin.adoc[leveloffset=+1] 18 | 19 | // Tekton 20 | include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc[leveloffset=+1] 21 | 22 | // Topology 23 | include::../dynamic-plugins/assembly-install-topology-plugin.adoc[leveloffset=+1] 24 | 25 | // Overriding Core Backend Service Configuration 26 | include::../modules/dynamic-plugins/proc-overriding-core-backend-services.adoc[leveloffset=+1] 27 | -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-install-topology-plugin.adoc: -------------------------------------------------------------------------------- 1 | [id="install-topology-plugin_{context}"] 2 | = Installing the Topology plugin 3 | 4 | include::../modules/dynamic-plugins/proc-topology-install.adoc[leveloffset=+2] 5 | 6 | include::../assembly-topology-plugin-configure.adoc[leveloffset=+1] 7 | 8 | include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1] 9 | 10 | include::../assembly-bulk-importing-from-github.adoc[leveloffset=+1] 11 | 12 | include::../assembly-using-servicenow.adoc[leveloffset=+1] 13 | 14 | include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-package-publish-third-party-dynamic-plugin.adoc: -------------------------------------------------------------------------------- 1 | [id="assembly-package-publish-third-party-dynamic-plugin"] 2 | = Packaging and publishing third-party plugins as dynamic plugins 3 | :context: assembly-package-publish-third-party-dynamic-plugin 4 | 5 | After xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[exporting a third-party plugin], you can package the derived package into one of the following supported formats: 6 | 7 | * Open Container Initiative (OCI) image (recommended) 8 | * TGZ file 9 | * JavaScript package 10 | + 11 | [IMPORTANT] 12 | ==== 13 | Exported dynamic plugin packages must only be published to private NPM registries. 14 | ==== 15 | 16 | //OCI image 17 | include::../modules/dynamic-plugins/proc-create-plugin-oci-image.adoc[leveloffset=+2] 18 | 19 | //TGZ file 20 | include::../modules/dynamic-plugins/proc-create-plugin-tgz-file.adoc[leveloffset=+2] 21 | 22 | //JavaScript package 23 | include::../modules/dynamic-plugins/proc-create-plugin-js-package.adoc[leveloffset=+2] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-reference-rhdh-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-reference-rhdh-plugins_{context}"] 2 | = Plugins reference 3 | 4 | include::../modules/dynamic-plugins/con-preinstalled-dynamic-plugins.adoc[leveloffset=+1] 5 | 6 | include::../modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1] 7 | 8 | [id="rhdh-supported-plugins"] 9 | include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+1] 10 | include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset=+1] 11 | // include::../modules/dynamic-plugins/ref-community-plugins.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-troubleshooting-rhdh-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-troubleshooting-rhdh-plugins_{context}"] 2 | = Troubleshooting {product-short} plugins 3 | 4 | //include::../modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-using-rhdh-plugins_{context}"] 2 | = Using dynamic plugins 3 | 4 | // Ansible 5 | include::../modules/dynamic-plugins/con-ansible-plugin-user.adoc[leveloffset=+1] 6 | 7 | // Argo CD 8 | include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc[leveloffset=+1] 9 | 10 | //JFrog Artifactory 11 | include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-user.adoc[leveloffset=+1] 12 | 13 | // Keycloak 14 | include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc[leveloffset=+1] 15 | 16 | // Nexus 17 | include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc[leveloffset=+1] 18 | 19 | // Tekton 20 | include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc[leveloffset=+1] 21 | 22 | // Topology 23 | include::../../assemblies/dynamic-plugins/assembly-using-topology-plugin.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-using-the-dynamic-plugins-cache.adoc: -------------------------------------------------------------------------------- 1 | [id="using-the-dynamic-plugins-cache_{context}"] 2 | = Using the dynamic plugins cache 3 | 4 | include::../modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[leveloffset=+1] 5 | include::../modules/dynamic-plugins/proc-creating-a-pvc-for-the-dynamic-plugin-cache-by-using-the-operator.adoc[leveloffset=+1] 6 | include::../modules/dynamic-plugins/proc-creating-a-pvc-for-the-dynamic-plugin-cache-by-using-helm.adoc[leveloffset=+1] 7 | include::../modules/dynamic-plugins/ref-configuring-the-dynamic-plugins-cache.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /assemblies/dynamic-plugins/assembly-using-topology-plugin.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: ASSEMBLY 2 | :context: using-topology-plugin 3 | [id="{context}"] 4 | = Using the Topology plugin 5 | 6 | Topology is a front-end plugin that enables you to view the workloads as nodes that power any service on the Kubernetes cluster. 7 | 8 | include::../modules/dynamic-plugins/proc-enable-users-to-use-topology-plugin.adoc[leveloffset=+1] 9 | 10 | include::../modules/dynamic-plugins/proc-using-topology-plugin.adoc[leveloffset=+1] 11 | -------------------------------------------------------------------------------- /assemblies/modules: -------------------------------------------------------------------------------- 1 | ../modules -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/aap-backend-plugin-user1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/aap-backend-plugin-user1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/aap-backend-plugin-user2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/aap-backend-plugin-user2.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/acr-plugin-user1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/acr-plugin-user1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/active-users.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/active-users.jpg -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/adoption-insights-catalog-entities.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/adoption-insights-catalog-entities.jpg -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/adoption-insights-daterange.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/adoption-insights-daterange.jpg -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/adoption-insights.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/adoption-insights.jpg -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/argo-cd-plugin-history.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/argo-cd-plugin-history.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/argo-cd-plugin-overview-card-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/argo-cd-plugin-overview-card-details.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/argo-cd-plugin-overview-card.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/argo-cd-plugin-overview-card.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/argocd.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/argocd.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/deployment_summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/deployment_summary.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/dynatrace-certified-and-verified.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/dynatrace-certified-and-verified.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/extensions-catalog-sidebar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/extensions-catalog-sidebar.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/extensions-catalog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/extensions-catalog.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/jfrog-artifactory.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/jfrog-artifactory.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/jfrog-plugin-user1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/jfrog-plugin-user1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/link.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/link.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/nexus-repository-manager.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/nexus-repository-manager.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/ocm-plugin-user1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/ocm-plugin-user1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/ocm-plugin-user2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/ocm-plugin-user2.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/quay-plugin-backstage1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/quay-plugin-backstage1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/quay-plugin-backstage2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/quay-plugin-backstage2.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/quay-plugin-backstage3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/quay-plugin-backstage3.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/rhdh-extensions-tekton-card.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/rhdh-extensions-tekton-card.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/rhdh-extensions-tekton-details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/rhdh-extensions-tekton-details.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/sidebar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/sidebar.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/tekton-plugin-pipeline-expand.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/tekton-plugin-pipeline-expand.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/tekton-plugin-pipeline.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/tekton-plugin-pipeline.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/tekton-plugin-user1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/tekton-plugin-user1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/tekton-plugin-user2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/tekton-plugin-user2.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/tekton-plugin-user3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/tekton-plugin-user3.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/topology-tab-user1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/topology-tab-user1.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/topology-tab-user2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/topology-tab-user2.png -------------------------------------------------------------------------------- /images/rhdh-plugins-reference/topology-tab-user3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh-plugins-reference/topology-tab-user3.png -------------------------------------------------------------------------------- /images/rhdh/disabling-telemetry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/disabling-telemetry.png -------------------------------------------------------------------------------- /images/rhdh/enable-gh-discovery.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/enable-gh-discovery.png -------------------------------------------------------------------------------- /images/rhdh/enable-gh-member-discovery.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/enable-gh-member-discovery.png -------------------------------------------------------------------------------- /images/rhdh/example-callback-url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/example-callback-url.png -------------------------------------------------------------------------------- /images/rhdh/helm-upgrade.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/helm-upgrade.png -------------------------------------------------------------------------------- /images/rhdh/operator-install-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/operator-install-1.png -------------------------------------------------------------------------------- /images/rhdh/operator-install-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/operator-install-2.png -------------------------------------------------------------------------------- /images/rhdh/rhdh-helm-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/rhdh-helm-install.png -------------------------------------------------------------------------------- /images/rhdh/segment-source-helm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/segment-source-helm.png -------------------------------------------------------------------------------- /images/rhdh/template-creation-not-successful.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/template-creation-not-successful.png -------------------------------------------------------------------------------- /images/rhdh/template-creation-successful.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/template-creation-successful.png -------------------------------------------------------------------------------- /images/rhdh/template-editor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/template-editor.png -------------------------------------------------------------------------------- /images/rhdh/upgrade-helm-metrics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/rhdh/upgrade-helm-metrics.png -------------------------------------------------------------------------------- /images/user-guide/custom-theme-mode-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redhat-developer/red-hat-developers-documentation-rhdh/2963f3c912f6d07906dce334125af0f4ad96b085/images/user-guide/custom-theme-mode-1.png -------------------------------------------------------------------------------- /modules/about/ref-customer-support-info.adoc: -------------------------------------------------------------------------------- 1 | [id="ref-customer-support-info_{context}"] 2 | = Red Hat Developer Hub support 3 | 4 | If you experience difficulty with a procedure described in this documentation, visit the http://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes: 5 | 6 | * To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products. 7 | * To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. 8 | * For detailed information about supported platforms and life cycle details, see link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle]. 9 | 10 | -------------------------------------------------------------------------------- /modules/about/ref-rhdh-sizing.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: REFERENCE 2 | [id="rhdh-sizing_{context}"] 3 | = Sizing requirements for {product} 4 | 5 | Scaling the {product} requires significant resource allocation. The following table lists the sizing requirements for installing and running {product}, including {product-short} application, database components, and Operator. 6 | 7 | .Recommended sizing for running {product} 8 | [cols="25%,25%,25%,25%", frame="all", options="header"] 9 | |=== 10 | |Components 11 | |{product} application 12 | |{product} database 13 | |{product} Operator 14 | 15 | |Central Processing Unit (CPU) 16 | |4 vCPU 17 | |2 vCPU 18 | |1 vCPU 19 | 20 | |Memory 21 | |16 GB 22 | |8 GB 23 | |1500 Mi 24 | 25 | |Storage size 26 | |2 GB 27 | |20 GB 28 | |50 Mi 29 | 30 | |Replicas 31 | |2 or more 32 | |3 or more 33 | |1 or more 34 | |=== -------------------------------------------------------------------------------- /modules/about/ref-supported-platforms.adoc: -------------------------------------------------------------------------------- 1 | :_newdoc-version: 2.18.3 2 | :_template-generated: 2024-11-08 3 | 4 | :_mod-docs-content-type: REFERENCE 5 | 6 | [id="supported-platforms_{context}"] 7 | = Supported platforms 8 | 9 | You can find the supported platforms and life cycle dates for both current and past versions of {product} on the link:https://access.redhat.com/support/policy/updates/developerhub[Life Cycle page]. 10 | 11 | -------------------------------------------------------------------------------- /modules/analytics/proc-customizing-segment-source-using-the-operator.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-customizing-telemetry-segment-using-operator_{context}"] 2 | = Customizing Segment source using the Operator 3 | 4 | You can configure integration with your Segment source by using the {product} Operator. 5 | 6 | .Prerequisites 7 | 8 | * You have logged in as an administrator in the {ocp-short} web console. 9 | * You have installed {product} on {ocp-short} using the Operator. 10 | 11 | .Procedure 12 | 13 | . Add the following YAML code in your `{product-custom-resource-type}` custom resource (CR): 14 | + 15 | [source,yaml] 16 | ---- 17 | # ... 18 | spec: 19 | application: 20 | extraEnvs: 21 | envs: 22 | - name: SEGMENT_WRITE_KEY 23 | value: # <1> 24 | # ... 25 | ---- 26 | <1> Replace `` with a unique identifier for your Segment source. 27 | 28 | . Save the configuration changes. 29 | -------------------------------------------------------------------------------- /modules/authorization/con-user-stats-rhdh.adoc: -------------------------------------------------------------------------------- 1 | [id='con-user-stats-rhdh_{context}'] 2 | = User statistics in {product} 3 | 4 | In {product}, the `licensed-users-info-backend` plugin provides statistical information about the logged-in users using the Web UI or REST API endpoints. 5 | 6 | The `licensed-users-info-backend` plugin enables administrators to monitor the number of active users on {product-short}. Using this feature, organizations can compare their actual usage with the number of licenses they have purchased. Additionally, you can share the user metrics with {company-name} for transparency and accurate licensing. 7 | 8 | The `licensed-users-info-backend` plugin is enabled by default. This plugin enables a *Download User List* link at the bottom of the *Administration -> RBAC* tab. -------------------------------------------------------------------------------- /modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc: -------------------------------------------------------------------------------- 1 | [id="configuring-the-rbac-backend-plugin_{context}"] 2 | = Configuring the RBAC backend plugin 3 | 4 | You can configure the RBAC backend plugin by updating the `{my-app-config-file}` file to enable the permission framework. 5 | 6 | .Prerequisites 7 | * You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}]. 8 | 9 | .Procedure 10 | * Update the `{my-app-config-file}` file to enable the permission framework as shown: 11 | 12 | [source,yaml,subs=+quotes] 13 | ---- 14 | permission 15 | enabled: true 16 | rbac: 17 | admin: 18 | users: 19 | - name: user:default/guest 20 | pluginsWithPermission: 21 | - catalog 22 | - permission 23 | - scaffolder 24 | ---- 25 | 26 | [NOTE] 27 | ==== 28 | The `pluginsWithPermission` section of the `{my-app-config-file}` file includes only three plugins by default. Update the section as needed to include any additional plugins that also incorporate permissions. 29 | ==== 30 | -------------------------------------------------------------------------------- /modules/authorization/proc-delegating-rbac-access-webui.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-delegating-rbac-access-webui_{context}'] 2 | = Delegating RBAC access in {product} by using the web UI 3 | 4 | You can delegate the RBAC access in {product} by using the web UI. 5 | 6 | .Procedure 7 | . Log in to your {product-very-short} instance with administrator credentials. 8 | . Navigate to *Administration → RBAC*. 9 | . Click *Create Role* and define a new role for team leads, such as `role:default/team_lead`. 10 | . In the *Members* section, add the user or group, such as `user:default/team_lead`. 11 | . Grant permissions required by team leads, such as: 12 | + 13 | -- 14 | * `policy.entity.create` to allow policy creation. 15 | * `catalog-entity:read` to allow catalog access. 16 | -- 17 | . Apply *conditions* to limit access as follows: 18 | + 19 | * Use the `IS_OWNER` rule to ensure team leads can only manage resources they own. 20 | 21 | . Click *Save* to create the role and apply changes. 22 | 23 | .Verification 24 | * Log in as a team lead. 25 | * Verify the following: 26 | + 27 | ** RBAC UI is accessible. 28 | ** Only users or roles related to their team are visible. 29 | ** No access to roles or permissions outside their scope is granted. -------------------------------------------------------------------------------- /modules/authorization/proc-download-user-stats-rhdh.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-download-user-stats-rhdh_{context}'] 2 | = Downloading active users list in {product} 3 | 4 | You can download the list of users in CSV format using the {product-short} web interface. 5 | 6 | .Prerequisites 7 | 8 | * RBAC plugins (`@backstage-community/plugin-rbac` and `@backstage-community/plugin-rbac-backend`) must be enabled in {product}. 9 | * An administrator role must be assigned. 10 | 11 | .Procedure 12 | 13 | . In {product}, navigate to *Administration* and select the *RBAC* tab. 14 | . At the bottom of the *RBAC* page, click *Download User List*. 15 | . Optional: Modify the file name in the *Save as* field and click *Save*. 16 | . To access the downloaded users list, go to the *Downloads* folder on your local machine and open the CSV file. 17 | -------------------------------------------------------------------------------- /modules/authorization/proc-rbac-ui-create-role.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-rbac-ui-create-role_{context}'] 2 | = Creating a role in the {product} Web UI 3 | 4 | You can create a role in the {product} using the Web UI. 5 | 6 | .Prerequisites 7 | * You xref:enabling-and-giving-access-to-rbac[have enabled RBAC, have a policy administrator role in {product-short}, and have added plugins with permission]. 8 | 9 | .Procedure 10 | 11 | . Go to *Administration* at the bottom of the sidebar in the {product-short}. 12 | + 13 | -- 14 | The *RBAC* tab appears, displaying all the created roles in the {product-short}. 15 | -- 16 | 17 | . (Optional) Click any role to view the role information on the *OVERVIEW* page. 18 | . Click *CREATE* to create a role. 19 | . Enter the name and description of the role in the given fields and click *NEXT*. 20 | . Add users and groups using the search field, and click *NEXT*. 21 | . Select *Plugin* and *Permission* from the drop-downs in the *Add permission policies* section. 22 | . Select or clear the *Policy* that you want to set in the *Add permission policies* section, and click *NEXT*. 23 | . Review the added information in the *Review and create* section. 24 | . Click *CREATE*. 25 | 26 | .Verification 27 | 28 | The created role appears in the list available in the *RBAC* tab. 29 | 30 | 31 | -------------------------------------------------------------------------------- /modules/authorization/proc-rbac-ui-delete-role.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-rbac-ui-delete-role_{context}'] 2 | = Deleting a role in the {product} Web UI 3 | 4 | You can delete a role in the {product} using the Web UI. 5 | 6 | [NOTE] 7 | ==== 8 | The policies generated from a `policy.csv` or ConfigMap file cannot be edited or deleted using the {product-short} Web UI. 9 | ==== 10 | 11 | .Prerequisites 12 | * You xref:enabling-and-giving-access-to-rbac[have enabled RBAC and have a policy administrator role in {product-short}]. 13 | * The role that you want to delete is created in the {product-short}. 14 | 15 | .Procedure 16 | 17 | . Go to *Administration* at the bottom of the sidebar in the {product-short}. 18 | + 19 | -- 20 | The *RBAC* tab appears, displaying all the created roles in the {product-short}. 21 | -- 22 | 23 | . (Optional) Click any role to view the role information on the *OVERVIEW* page. 24 | . Select the delete icon from the *Actions* column for the role that you want to delete. 25 | + 26 | *Delete this role?* pop-up appears on the screen. 27 | . Click *DELETE*. 28 | -------------------------------------------------------------------------------- /modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc: -------------------------------------------------------------------------------- 1 | [id="setting-up-the-guest-authentication-provider_{context}"] 2 | = Setting up the guest authentication provider 3 | 4 | You can enable guest authentication and use it alongside the RBAC frontend plugin. 5 | 6 | .Prerequisites 7 | * You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}]. 8 | 9 | .Procedure 10 | 11 | * In the `{my-app-config-file}` file, add the user entity reference to resolve and enable the `dangerouslyAllowOutsideDevelopment` option, as shown in the following example: 12 | 13 | [source,yaml,subs="+attributes,+quotes"] 14 | ---- 15 | auth: 16 | environment: development 17 | providers: 18 | guest: 19 | userEntityRef: user:default/guest 20 | dangerouslyAllowOutsideDevelopment: true 21 | ---- 22 | 23 | [NOTE] 24 | ==== 25 | You can use `user:default/guest` as the user entity reference to match the added user under the `permission.rbac.admin.users` section of the `{my-app-config-file}` file. 26 | ==== 27 | -------------------------------------------------------------------------------- /modules/authorization/proc_enabling_transitive_parent_groups.adoc: -------------------------------------------------------------------------------- 1 | = Enabling transitive parent groups 2 | 3 | By default, {product} does not resolve indirect parent groups during authentication. 4 | In this case, with the following group hierarchy, the `user_alice` user is only a member of the `group_developers` group: 5 | 6 | ---- 7 | group_admin 8 | └── group_developers 9 | └── user_alice 10 | ---- 11 | 12 | To support multi-level group hierarchies when using the $ownerRefs alias, you can configure {product-short} to include indirect parent groups in the user’s ownership entities. 13 | In that case the `user_alice` user is a member of both `group_developers` and `group_admin` groups. 14 | 15 | .Procedure 16 | 17 | * Enable the `includeTransitiveGroupOwnership` option in your `{my-app-config-file}` file. 18 | + 19 | [source,yaml] 20 | ---- 21 | includeTransitiveGroupOwnership: true 22 | ---- 23 | -------------------------------------------------------------------------------- /modules/authorization/snip-finding-bearer-token.adoc: -------------------------------------------------------------------------------- 1 | . Find your Bearer token to authenticate to the REST API. 2 | .. In your browser, open the web console *Network* tab. 3 | .. In the main screen, reload the {product-short} *Homepage*. 4 | .. In the web console *Network* tab, search for the `query?term=` network call. 5 | .. Save the *token* in the response JSON for the next steps. 6 | -------------------------------------------------------------------------------- /modules/con-rhdh-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="con-rhdh-plugins"] 2 | 3 | = Plugins in {product} 4 | 5 | The {product} application offers a unified platform with various plugins. Using the plugin ecosystem within the {product-short} application, you can access any kind of development infrastructure or software development tool. 6 | 7 | The plugins in {product-short} maximize the productivity and streamline the development workflows by maintaining the consistency in the overall user experience. -------------------------------------------------------------------------------- /modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-helm-chart-deployment.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-configuring-high-availability-in-rhdh-helm-chart-deployment"] 2 | = Configuring high availability in a {product} Helm chart deployment 3 | 4 | When you are deploying {product-short} using the Helm chart, you must set `replicas` to a value greater than `1` in your Helm chart. The default value for `replicas` is `1`. 5 | 6 | .Procedure 7 | To configure your {product-short} Helm chart for high availability, complete the following step: 8 | 9 | * In your Helm chart configuration file, set `replicas` to a value greater than `1`. For example: 10 | + 11 | ==== 12 | [source,yaml,subs="+attributes,+quotes"] 13 | ---- 14 | upstream: 15 | backstage: 16 | replicas: __ <1> 17 | ---- 18 | ==== 19 | <1> Set the number of replicas based on the number of backup instances that you want to configure. -------------------------------------------------------------------------------- /modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-operator-deployment.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-configuring-high-availability-in-rhdh-operator-deployment"] 2 | = Configuring High availability in a {product} Operator deployment 3 | 4 | {product-very-short} instances that are deployed with the Operator use configurations in the `{product-custom-resource-type}` custom resource. In the `{product-custom-resource-type}` custom resource, the default value for the `replicas` field is `1`. If you want to configure your {product-very-short} instance for high availability, you must set `replicas` to a value greater than `1`. 5 | 6 | 7 | .Procedure 8 | 9 | * In your `{product-custom-resource-type}` custom resource, set `replicas` to a value greater than `1`. For example: 10 | + 11 | ==== 12 | [source,yaml,subs="+attributes,+quotes"] 13 | ---- 14 | apiVersion: rhdh.redhat.com/v1alpha3 15 | kind: Backstage 16 | metadata: 17 | name: __ 18 | spec: 19 | application: 20 | ... 21 | replicas: __ <1> 22 | ... 23 | ---- 24 | ==== 25 | <1> Set the number of replicas based on the number of backup instances that you want to configure. -------------------------------------------------------------------------------- /modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-configuring-readonlyrootfilesystem-option-in-rhdh-helm-chart-deployment"] 2 | = Configuring the readOnlyRootFilesystem option in a {product} Helm chart deployment 3 | 4 | .Procedure 5 | . In your `values.yaml` file, add the `readOnlyRootFilesystem: true` line to the `containerSecurityContext` section. For example: 6 | + 7 | ==== 8 | [source,yaml,subs="+attributes,+quotes"] 9 | ---- 10 | upstream: 11 | backstage: 12 | containerSecurityContext: 13 | readOnlyRootFilesystem: true 14 | ---- 15 | ==== 16 | -------------------------------------------------------------------------------- /modules/configuring-readonlyrootfilesystem/proc-configuring-readonlyrootfilesystem-option-in-rhdh-operator-deployment.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-configuring-readonlyrootfilesystem-option-in-rhdh-operator-deployment"] 2 | = Configuring the readOnlyRootFilesystem option in a {product} Operator deployment 3 | 4 | When you are deploying {product-short} using the Operator, you must specify a `patch` for the `deployment` in your `{product-custom-resource-type}` custom resource (CR) that applies the `readOnlyRootFilesystem` option to the `securityContext` section in the {product-short} backend container. 5 | 6 | .Procedure 7 | 8 | . In your `{product-custom-resource-type}` CR, add the `securityContext` specification. For example: 9 | + 10 | ==== 11 | [source,yaml,subs="+attributes,+quotes"] 12 | ---- 13 | spec: 14 | deployment: 15 | patch: 16 | spec: 17 | template: 18 | spec: 19 | containers: 20 | - name: backstage-backend <1> 21 | securityContext: 22 | readOnlyRootFilesystem: true 23 | ---- 24 | ==== 25 | <1> Name of the main container defined in the Operator default configuration. -------------------------------------------------------------------------------- /modules/conscious-language.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Conscious language note 3 | Add this to the preface. 4 | //// 5 | [preface] 6 | [discrete] 7 | [id="making-open-source-more-inclusive"] 8 | = Making open source more inclusive 9 | Red Hat is committed to replacing problematic language in our code, documentation, and web properties. 10 | We are beginning with these four terms: master, slave, blacklist, and whitelist. 11 | Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. 12 | For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message]. 13 | -------------------------------------------------------------------------------- /modules/customizing-techdocs/con-techdocs-config-cicd.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: CONCEPT 2 | [id="con-techdocs-config-cicd_{context}"] 3 | = Configuring CI/CD to generate and publish TechDocs sites 4 | 5 | TechDocs reads the static generated documentation files from a cloud storage bucket, such as {odf-name}. The documentation site is generated on the CI/CD workflow associated with the repository containing the documentation files. You can generate docs on CI and publish to a cloud storage using the `techdocs-cli` CLI tool. 6 | 7 | You can use the following example to create a script for TechDocs publication: 8 | 9 | [source,shell] 10 | ---- 11 | # Prepare 12 | REPOSITORY_URL='https://github.com/org/repo' 13 | git clone $REPOSITORY_URL 14 | cd repo 15 | 16 | # Install @techdocs/cli, mkdocs and mkdocs plugins 17 | npm install -g @techdocs/cli 18 | pip install "mkdocs-techdocs-core==1.*" 19 | 20 | # Generate 21 | techdocs-cli generate --no-docker 22 | 23 | # Publish 24 | techdocs-cli publish --publisher-type awsS3 --storage-name --entity 25 | ---- 26 | 27 | The TechDocs workflow starts the CI when a user makes changes in the repository containing the documentation files. You can configure the workflow to start only when files inside the `docs/` directory or `mkdocs.yml` are changed. 28 | -------------------------------------------------------------------------------- /modules/customizing-techdocs/con-techdocs-configure-storage.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: CONCEPT 2 | [id="con-techdocs-configure-storage_{context}"] 3 | = Configuring storage for TechDocs files 4 | 5 | The TechDocs publisher stores generated files in local storage or in cloud storage, such as {odf-name}, Google GCS, AWS S3, or Azure Blob Storage. 6 | -------------------------------------------------------------------------------- /modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-techdocs-config-cicd-prep-repo_{context}"] 3 | = Preparing your repository for CI 4 | 5 | The first step on the CI is to clone your documentation source repository in a working directory. 6 | 7 | .Procedure 8 | 9 | * To clone your documentation source repository in a working directory, enter the following command: 10 | + 11 | [source,terminal] 12 | ---- 13 | git clone 14 | ---- 15 | -------------------------------------------------------------------------------- /modules/customizing-techdocs/proc-techdocs-generate-site.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-techdocs-generate-site_{context}"] 3 | = Generating the TechDocs site 4 | 5 | .Procedure 6 | 7 | To configure CI/CD to generate your techdocs, complete the following steps: 8 | 9 | . Install the `npx` package to run `techdocs-cli` using the following command: 10 | + 11 | [source] 12 | ---- 13 | npm install -g npx 14 | ---- 15 | 16 | . Install the `techdocs-cli` tool using the following command: 17 | + 18 | [source] 19 | ---- 20 | npm install -g @techdocs/cli 21 | ---- 22 | 23 | . Install the `mkdocs` plugins using the following command: 24 | + 25 | [source] 26 | ---- 27 | pip install "mkdocs-techdocs-core==1.*" 28 | ---- 29 | 30 | . Generate your techdocs site using the following command: 31 | + 32 | [source,terminal] 33 | ---- 34 | npx @techdocs/cli generate --no-docker --source-dir --output-dir ./site 35 | ---- 36 | + 37 | Where `` is the location in the file path that you used to clone your repository. 38 | -------------------------------------------------------------------------------- /modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: REFERENCE 2 | [id="ref-techdocs-example-config-plugin-helm_{context}"] 3 | = Example TechDocs Plugin configuration for the Helm chart 4 | 5 | The following example shows a {product-short} Helm chart configuration for the TechDocs plugin: 6 | 7 | [source,yaml] 8 | ---- 9 | global: 10 | dynamic: 11 | includes: 12 | - 'dynamic-plugins.default.yaml' 13 | plugins: 14 | - disabled: false 15 | package: ./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic 16 | pluginConfig: 17 | techdocs: 18 | builder: external 19 | generator: 20 | runIn: local 21 | publisher: 22 | awsS3: 23 | bucketName: '${BUCKET_NAME}' 24 | credentials: 25 | accessKeyId: '${AWS_ACCESS_KEY_ID}' 26 | secretAccessKey: '${AWS_SECRET_ACCESS_KEY}' 27 | endpoint: 'https://${BUCKET_HOST}' 28 | region: '${BUCKET_REGION}' 29 | s3ForcePathStyle: true 30 | type: awsS3 31 | ---- 32 | -------------------------------------------------------------------------------- /modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: REFERENCE 2 | [id="ref-techdocs-example-config-plugin-operator_{context}"] 3 | = Example TechDocs Plugin configuration for the Operator 4 | 5 | The following example shows a {product} Operator config map configuration for the TechDocs plugin: 6 | 7 | [source,yaml] 8 | ---- 9 | kind: ConfigMap 10 | apiVersion: v1 11 | metadata: 12 | name: dynamic-plugins-rhdh 13 | data: 14 | dynamic-plugins.yaml: | 15 | includes: 16 | - dynamic-plugins.default.yaml 17 | plugins: 18 | - disabled: false 19 | package: ./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic 20 | pluginConfig: 21 | techdocs: 22 | builder: external 23 | generator: 24 | runIn: local 25 | publisher: 26 | awsS3: 27 | bucketName: '${BUCKET_NAME}' 28 | credentials: 29 | accessKeyId: '${AWS_ACCESS_KEY_ID}' 30 | secretAccessKey: '${AWS_SECRET_ACCESS_KEY}' 31 | endpoint: 'https://${BUCKET_HOST}' 32 | region: '${BUCKET_REGION}' 33 | s3ForcePathStyle: true 34 | type: awsS3 35 | ---- 36 | -------------------------------------------------------------------------------- /modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-configuring-templates.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-searching-and-filtering-software-templates_{context}"] 7 | = Searching and filtering Software Templates in your {product} instance 8 | 9 | You can search and filter for the Software Template that you want to use to create a new software component. 10 | 11 | .Procedure 12 | 13 | To search and filter for a Software Template, complete the following steps: 14 | 15 | . In the {product} navigation menu, click *Catalog* > *Self-service*. 16 | . Type the name of the template you are looking for in the *Search* box. 17 | * If you are looking for templates in a certain category, you can use the *Categories* dropdown. -------------------------------------------------------------------------------- /modules/customizing-the-appearance/con-customize-rhdh-sidebar-menuitems.adoc: -------------------------------------------------------------------------------- 1 | [id='con-customize-rhdh-sidebar-menuitems_{context}'] 2 | = Customizing the sidebar menu items for your {product-short} instance 3 | 4 | The sidebar menu in {product} consists of two main parts that you can configure: 5 | 6 | Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu. 7 | Main menu items:: The core navigation structure of sidebar is static. 8 | 9 | * *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins. -------------------------------------------------------------------------------- /modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // assembly-customizing-the-appearance.adoc 3 | 4 | [id="proc-customizing-rhdh-theme-mode_{context}"] 5 | = Customizing the theme mode for your {product-short} instance 6 | 7 | [NOTE] 8 | ==== 9 | In {product-short}, theme configurations are used to change the look and feel of different UI components. So, you might notice changes in different UI components, such as buttons, tabs, sidebars, cards, and tables along with some changes in background color and font used on the {product-very-short} pages. 10 | ==== 11 | 12 | You can choose one of the following theme modes for your {product-short} instance: 13 | 14 | * Light theme 15 | * Dark theme 16 | * Auto 17 | 18 | The default theme mode is Auto, which automatically sets the light or dark theme based on your system preferences. 19 | 20 | .Prerequisites 21 | 22 | * You are logged in to the {product-short} web console. 23 | 24 | .Procedure 25 | 26 | . From the {product-short} web console, click *Settings*. 27 | . From the *Appearance* panel, click *LIGHT THEME*, *DARK THEME*, or *AUTO* to change the theme mode. 28 | + 29 | image::user-guide/custom-theme-mode-1.png[] 30 | 31 | // [NOTE] 32 | // ==== 33 | // If you choose the *AUTO* theme mode, ... 34 | // ==== 35 | -------------------------------------------------------------------------------- /modules/customizing-the-learning-paths/con-about-learning-paths.adoc: -------------------------------------------------------------------------------- 1 | [id='con-about-learning-paths_{context}'] 2 | = About Learning Paths 3 | 4 | You can use the Learning Paths plugin in {product} to integrate customized e-learning content into the developer workflows. By using Learning Paths, you can create a collaborative learning culture, boost productivity, and ensure that teams stay updated with relevant best practices and technologies. The overall purpose is to accelerate onboarding, address skill gaps, ensure regulatory compliance, promote best practices, and facilitate product updates. -------------------------------------------------------------------------------- /modules/customizing-the-learning-paths/proc-starting-and-completing-lessions-in-learning-paths.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-starting-and-completing-lessons-in-learning-paths_{context}'] 2 | = Starting and completing lessons in Learning Paths 3 | 4 | As a developer, you can start a course and complete the lessons at your own pace. 5 | 6 | .Prerequisites 7 | . You can log in to developers.redhat.com 8 | . Your platform engineer has granted you access to the Learning Paths plugin. 9 | 10 | 11 | .Procedure 12 | To start a course in Learning Paths, complete the following steps: 13 | 14 | . In your {product} navigation menu, click *Learning Paths*. 15 | . Select the tile for the course you would like to begin. 16 | + 17 | [NOTE] 18 | ==== 19 | This action redirects you to the main page of the course in link:https://developers.redhat.com[the Red Hat Developers site]. 20 | ==== -------------------------------------------------------------------------------- /modules/customizing/proc-customizing-your-product-base-url.adoc: -------------------------------------------------------------------------------- 1 | [id="customizing-your-product-se-url"] 2 | = Customizing your {product} base URL 3 | 4 | You can change the default {product} base URL. 5 | 6 | .Prerequisites 7 | * You know your desired {product-short} external URL: pass:c,a,q[{my-product-url}], and have configured DNS to point to your {ocp-brand-name} cluster. 8 | * link:{configuring-book-url}[Custom {product-short} configuration]. 9 | 10 | .Procedure 11 | * In your custom `{my-app-config-file}` file, enter your {product-short} external URL, such as pass:c,a,q[{my-product-url}]. 12 | + 13 | .`{my-app-config-file}` excerpt 14 | [source,yaml,subs="+attributes,+quotes"] 15 | ---- 16 | app: 17 | baseUrl: {my-product-url} 18 | backend: 19 | baseUrl: {my-product-url} 20 | cors: 21 | origin: {my-product-url} 22 | ---- 23 | -------------------------------------------------------------------------------- /modules/customizing/proc-customizing-your-product-title.adoc: -------------------------------------------------------------------------------- 1 | [id="customizing-your-product-title"] 2 | = Customizing your {product} title 3 | 4 | You can change the default {product} display name. 5 | 6 | .Prerequisites 7 | * link:{configuring-book-url}[Custom {product-short} configuration]. 8 | 9 | .Procedure 10 | * In your custom `{my-app-config-file}` file, enter your {product-short} instance display name, such as _<{product}>_. 11 | + 12 | .`{my-app-config-file}` excerpt 13 | [source,yaml,subs="+attributes,+quotes"] 14 | ---- 15 | app: 16 | title: My custom {product} title 17 | ---- 18 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/con-ansible-plugin-admin.adoc: -------------------------------------------------------------------------------- 1 | = Installing Ansible plug-ins for {product} 2 | 3 | Ansible plug-ins for {product} deliver an Ansible-specific portal experience with curated learning paths, 4 | push-button content creation, integrated development tools, and other opinionated resources. 5 | 6 | To install and configure the Ansible plugins, see 7 | link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_]. 8 | 9 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/con-basic-config-dynamic-plugins.adoc: -------------------------------------------------------------------------------- 1 | [id="con-basic-config-dynamic-plugins"] 2 | 3 | = Basic configuration of dynamic plugins 4 | 5 | Some dynamic plugins require environment variables to be set. If a mandatory environment variable is not set, and the plugin is enabled, then the application might fail at startup. 6 | 7 | //The mandatory environment variables for each plugin are listed in the xref:rhdh-supported-plugins[Dynamic plugins support matrix]. 8 | 9 | [NOTE] 10 | ==== 11 | Zib-bomb detection 12 | When installing some dynamic plugin containing large files, if the installation script considers the package archive to be a Zib-Bomb, the installation fails. 13 | 14 | To increase the maximum permitted size of a file inside a package archive, you can increase the `MAX_ENTRY_SIZE` environment value of the deployment `install-dynamic-plugins initContainer` from the default size of `20000000` bytes. 15 | ==== 16 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/con-catalog-searching-and-filtering.adoc: -------------------------------------------------------------------------------- 1 | = Search and filter the plugins 2 | 3 | == Search by plugin name 4 | You can use the search bar in the header to filter the Extensions plugin cards by name. For example, if you type “A” into the search bar, Extensions shows only the plugins that contain the letter “A” in the Name field. 5 | 6 | image::rhdh-plugins-reference/dynatrace-certified-and-verified.png[Extensions catalog with a Dynatrace search] 7 | 8 | Optionally, you can use the search bar in conjunction with a filter to filter only plugins of the selected filter by name. For example, you can apply the *Category* filter and then type a character into the search bar to view only Openshift plugins that contain the typed character in the name. 9 | 10 | The following filters are available: 11 | 12 | * Category 13 | * Author 14 | * Support type -------------------------------------------------------------------------------- /modules/dynamic-plugins/con-dynamic-plugins-cache.adoc: -------------------------------------------------------------------------------- 1 | [id="con-dynamic-plugin-cache_{context}"] 2 | 3 | = Using the dynamic plugins cache 4 | The dynamic plugins cache in {product} ({product-very-short}) enhances the installation process and reduces platform boot time by storing previously installed plugins. If the configuration remains unchanged, this feature prevents the need to re-download plugins on subsequent boots. 5 | 6 | When you enable dynamic plugins cache: 7 | 8 | * The system calculates a checksum of each plugin's YAML configuration (excluding `pluginConfig`). 9 | * The checksum is stored in a file named `dynamic-plugin-config.hash` within the plugin's directory. 10 | * During boot, if a plugin's package reference matches the previous installation and the checksum is unchanged, the download is skipped. 11 | * Plugins that are disabled since the previous boot are automatically removed. 12 | 13 | [NOTE] 14 | To enable the dynamic plugins cache in {product-very-short}, the plugins directory `dynamic-plugins-root` must be a persistent volume. -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-app-grouping.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-app-grouping"] 2 | 3 | = App grouping 4 | 5 | To display workload resources such as deployments or pods in a visual group, add the following label: 6 | 7 | [source,yaml] 8 | ---- 9 | labels: 10 | app.kubernetes.io/part-of: 11 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-catalog-viewing.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-extensions-plugins-viewing_{context}"] 2 | = Viewing available plugins 3 | 4 | You can view plugins available for your {product} application on the *Extensions* page. 5 | 6 | .Procedure 7 | 8 | . Open your {product-short} application and click *Administration* > *Extensions*. 9 | . Go to the *Catalog* tab to view a list of available plugins and related information. 10 | + 11 | image::rhdh-plugins-reference/extensions-catalog.png[Extensions Catalog] -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-create-plugin-js-package.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-create-plugin-js-package_{context}"] 2 | = Creating a JavaScript package with dynamic packages 3 | 4 | [WARNING] 5 | ==== 6 | The derived dynamic plugin JavaScript packages must not be published to the public NPM registry. If you must publish to the NPM registry, use a private registry. 7 | ==== 8 | 9 | .Prerequisites 10 | * You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[]. 11 | 12 | .Procedure 13 | . Navigate to the `dist-dynamic` directory. 14 | . Run the following command to publish the package to your private NPM registry: 15 | + 16 | -- 17 | .Example command to publish a plugin package to an NPM registry 18 | [source,terminal] 19 | ---- 20 | npm publish --registry 21 | ---- 22 | 23 | [TIP] 24 | ==== 25 | You can add the following to your `package.json` file before running the `export` command: 26 | 27 | .Example `package.json` file 28 | [source,json] 29 | ---- 30 | { 31 | "publishConfig": { 32 | "registry": "" 33 | } 34 | } 35 | ---- 36 | 37 | If you modify `publishConfig` after exporting the dynamic plugin, re-run the `export-dynamic-plugin` command to ensure the correct configuration is included. 38 | ==== 39 | -- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-enabling-the-source-code-editor.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-enabling-the-source-code-editor_{context}"] 2 | = Enabling the source code editor 3 | 4 | To enable the source code editor, you must grant read access to the CheClusters resource in the `ClusterRole` as shown in the following example code: 5 | 6 | [source,yaml] 7 | ---- 8 | ... 9 | apiVersion: rbac.authorization.k8s.io/v1 10 | kind: ClusterRole 11 | metadata: 12 | name: backstage-read-only 13 | rules: 14 | ... 15 | - apiGroups: 16 | - org.eclipse.che 17 | resources: 18 | - checlusters 19 | verbs: 20 | - get 21 | - list 22 | ---- 23 | 24 | To use the source code editor, you must add the following configuration to the `kubernetes.customResources` property in your `{my-app-config-file}` file: 25 | 26 | [source,yaml] 27 | ---- 28 | kubernetes: 29 | ... 30 | customResources: 31 | - group: 'org.eclipse.che' 32 | apiVersion: 'v2' 33 | plural: 'checlusters' 34 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-entity-annotation-or-label.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-entity-annotation-or-label"] 2 | 3 | = Entity annotation/label 4 | 5 | For {product-very-short} to detect that an entity has Kubernetes components, add the following annotation to the `catalog-info.yaml` file of the entity: 6 | 7 | [source,yaml] 8 | ---- 9 | annotations: 10 | backstage.io/kubernetes-id: 11 | ---- 12 | 13 | Add the following label to the resources so that the Kubernetes plugin gets the Kubernetes resources from the requested entity: 14 | 15 | [source,yaml] 16 | ---- 17 | labels: 18 | backstage.io/kubernetes-id: ` 19 | ---- 20 | 21 | [NOTE] 22 | ==== 23 | When using the label selector, the mentioned labels must be present on the resource. 24 | ==== -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-extensions-disabling.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-extensions-plugins-disabling_{context}"] 2 | = Removing Extensions 3 | The Extensions feature plugins are preinstalled in {product} ({product-very-short}) and enabled by default. If you want to remove Extensions from your {product-very-short} instance, you can disable the relevant plugins. 4 | 5 | .Procedure 6 | . To disable the the Extensions feature plugins, edit your `dynamic-plugins.yaml` with the following content. 7 | + 8 | .`dynamic-plugins.yaml` fragment 9 | [source,yaml] 10 | ---- 11 | plugins: 12 | - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace 13 | disabled: true 14 | - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-catalog-backend-module-marketplace-dynamic 15 | disabled: true 16 | - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic 17 | disabled: true 18 | ---- 19 | 20 | [NOTE] 21 | If you disable the Extensions feature plugins, the *Catalog* and *Installed* tabs will also be removed. You can still view installed plugins by clicking on *Administration* > *Extensions*. -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-extensions-managing.adoc: -------------------------------------------------------------------------------- 1 | [id="rhdh-extensions-plugins-managing_{context}"] 2 | = Managing Extensions plugin metadata in {product} 3 | 4 | You must add the Extensions catalog entities to your {product-very-short} container image by updating your `app-config.yaml` file, 5 | 6 | .Prerequisites 7 | * You have installed the `marketplace` plugin. 8 | 9 | .Procedure 10 | . Update the `catalog.locations` definition in your `app-config.yaml` file, as follows: 11 | + 12 | [source,yaml] 13 | ---- 14 | appConfig: 15 | catalog: 16 | rules: 17 | - allow: [Component, System, API, Resource, Location, PluginCollection, Plugin, Package] 18 | locations: 19 | - type: file 20 | target: /marketplace/catalog-entities/plugins/all.yaml 21 | rules: 22 | - allow: [Location, Plugin] 23 | - type: file 24 | target: /marketplace/catalog-entities/packages/all.yaml 25 | rules: 26 | - allow: [Location, Package] 27 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-icon-displayed-in-the-node.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-icon-displayed-in-the-node"] 2 | 3 | = Icon displayed in the node 4 | 5 | To display a runtime icon in the topology nodes, add the following label to workload resources, such as Deployments: 6 | 7 | [source,yaml] 8 | ---- 9 | labels: 10 | app.openshift.io/runtime: 11 | ---- 12 | Alternatively, you can include the following label to display the runtime icon: 13 | 14 | [source,yaml] 15 | ---- 16 | labels: 17 | app.kubernetes.io/name: 18 | ---- 19 | 20 | Supported values of `` include: 21 | 22 | * django 23 | * dotnet 24 | * drupal 25 | * go-gopher 26 | * golang 27 | * grails 28 | * jboss 29 | * jruby 30 | * js 31 | * nginx 32 | * nodejs 33 | * openjdk 34 | * perl 35 | * phalcon 36 | * php 37 | * python 38 | * quarkus 39 | * rails 40 | * redis 41 | * rh-spring-boot 42 | * rust 43 | * java 44 | * rh-openjdk 45 | * ruby 46 | * spring 47 | * spring-boot 48 | 49 | [NOTE] 50 | ==== 51 | Other values result in icons not being rendered for the node. 52 | ==== -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-install-plugins-using-custom-npm-registry.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-install-plugins-using-custom-npm-registry"] 2 | 3 | //= Using a custom NPM registry for dynamic plugin packages 4 | = Installing dynamic plugins in an air-gapped environment 5 | 6 | You can install external plugins in an air-gapped environment by setting up a custom NPM registry. 7 | 8 | You can configure the NPM registry URL and authentication information for dynamic plugin packages using a Helm chart. For dynamic plugin packages obtained through `npm pack`, you can use a `.npmrc` file. 9 | 10 | Using the Helm chart, add the `.npmrc` file to the NPM registry by creating a secret. For example: 11 | 12 | [source,yaml,subs="+quotes,+attributes"] 13 | ---- 14 | apiVersion: v1 15 | kind: Secret 16 | metadata: 17 | name: `__-dynamic-plugins-npmrc` # <1> 18 | type: Opaque 19 | stringData: 20 | .npmrc: | 21 | registry= 22 | //:_authToken= 23 | ... 24 | ---- 25 | <1> Replace `__` with your Helm release name. This name is a unique identifier for each chart installation in the Kubernetes cluster. -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-load-plugin-tgz-file.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-load-plugin-tgz-file_{context}"] 2 | = Loading a plugin packaged as a TGZ file 3 | 4 | .Prerequisites 5 | * The third-party plugin is packaged as a dynamic plugin in a TGZ file. 6 | + 7 | For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[]. 8 | 9 | .Procedure 10 | 11 | . Specify the archive URL and its integrity hash in the `dynamic-plugins.yaml` file using the following example: 12 | + 13 | -- 14 | .Example configuration in `dynamic-plugins.yaml` file 15 | [source,yaml] 16 | ---- 17 | plugins: 18 | - disabled: false 19 | package: https://example.com/backstage-plugin-myplugin-1.0.0.tgz 20 | integrity: sha512-9WlbgEdadJNeQxdn1973r5E4kNFvnT9GjLD627GWgrhCaxjCmxqdNW08cj+Bf47mwAtZMt1Ttyo+ZhDRDj9PoA== 21 | ---- 22 | -- 23 | 24 | . To apply the changes, restart the {product-very-short} application. -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-namespace-annotation.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-namespace-annotation"] 2 | 3 | = Namespace annotation 4 | 5 | .Procedure 6 | * To identify the Kubernetes resources using the defined namespace, add the `backstage.io/kubernetes-namespace` annotation: 7 | + 8 | [source,yaml] 9 | ---- 10 | annotations: 11 | backstage.io/kubernetes-namespace: 12 | ---- 13 | + 14 | The Red Hat OpenShift Dev Spaces instance is not accessible using the source code editor if the `backstage.io/kubernetes-namespace` annotation is added to the `catalog-info.yaml` file. 15 | + 16 | To retrieve the instance URL, you require the CheCluster custom resource (CR). As the CheCluster CR is created in the openshift-devspaces namespace, the instance URL is not retrieved if the namespace annotation value is not openshift-devspaces. -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-node-connector.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-node-connector"] 2 | 3 | = Node connector 4 | 5 | .Procedure 6 | To display the workload resources such as deployments or pods with a visual connector, add the following annotation: 7 | + 8 | [source,yaml] 9 | ---- 10 | annotations: 11 | app.openshift.io/connects-to: '[{"apiVersion": ,"kind": ,"name": }]' 12 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-obtaining-integrity-checksum.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-obtaining-integrity-checksum"] 2 | 3 | = Obtaining the integrity checksum 4 | 5 | To obtain the integrity checksum, enter the following command: 6 | 7 | ---- 8 | npm view @ dist.integrity 9 | ---- 10 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-rhdh-installing-external-dynamic-plugins-airgapped.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-rhdh-installing-external-dynamic-plugins-airgapped"] 2 | 3 | = Installing external plugins in an air-gapped environment 4 | 5 | You can install external plugins in an air-gapped environment by setting up a custom NPM registry. To configure the NPM registry URL and authentication information for dynamic plugin packages, see xref:proc-using-custom-npm-registry[Using a custom NPM registry for dynamic plugin packages]. 6 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-topology-install.adoc: -------------------------------------------------------------------------------- 1 | = Installation 2 | The Topology plugin enables you to visualize the workloads such as Deployment, Job, Daemonset, Statefulset, CronJob, Pods and Virtual Machines powering any service on your Kubernetes cluster. 3 | 4 | .Prerequisites 5 | * You have installed and configured the @backstage/plugin-kubernetes-backend dynamic plugins. 6 | * You have configured the Kubernetes plugin to connect to the cluster using a ServiceAccount. 7 | * The `ClusterRole` must be granted to ServiceAccount accessing the cluster. 8 | [NOTE] 9 | If you have the {product-short} Kubernetes plugin configured, then the `ClusterRole` is already granted. 10 | 11 | .Procedure 12 | * The Topology plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the disabled property to false as follows: 13 | + 14 | .`{my-app-config-file}` fragment 15 | [source,yaml] 16 | ---- 17 | auth: 18 | global: 19 | dynamic: 20 | includes: 21 | - dynamic-plugins.default.yaml 22 | plugins: 23 | - package: ./dynamic-plugins/dist/backstage-community-plugin-topology 24 | disabled: false 25 | ---- 26 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-using-topology-plugin.adoc: -------------------------------------------------------------------------------- 1 | [id="using-the-topology-plugin"] 2 | = Using the Topology plugin 3 | 4 | .Prerequisites 5 | * Your {product} instance is installed and running. 6 | * You have installed the Topology plugin. 7 | //For the installation process, see Installation. 8 | * You have xref:enable-users-to-use-the-topology-plugin[enabled the users to use the Topology plugin]. 9 | 10 | .Procedure 11 | 12 | . Open your {product-very-short} application and select a component from the *Catalog* page. 13 | . Go to the *TOPOLOGY* tab and you can view the workloads such as deployments or pods as nodes. 14 | + 15 | image::rhdh-plugins-reference/topology-tab-user1.png[topology-user-1] 16 | 17 | . Select a node and a pop-up appears on the right side that contains two tabs: *Details* and *Resources*. 18 | + 19 | The *Details* and *Resources* tabs contain the associated information and resources for the node. 20 | + 21 | image::rhdh-plugins-reference/topology-tab-user2.png[topology-user-2] 22 | 23 | . Click the *Open URL* button on the top of a node. 24 | + 25 | image::rhdh-plugins-reference/topology-tab-user3.png[topology-user-3] 26 | + 27 | Click the *Open URL* button to access the associated *Ingresses* and run your application in a new tab. 28 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-viewing-installed-plugins.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // assemblies/assembly-rhdh-installing-dynamic-plugins.adoc 4 | // assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc 5 | 6 | :_mod-docs-content-type: PROCEDURE 7 | [id="proc-viewing-installed-plugins_{context}"] 8 | = Viewing installed plugins 9 | 10 | Using the Dynamic Plugins Info front-end plugin, you can view plugins that are currently installed in your {product} application. This plugin is enabled by default. 11 | 12 | .Procedure 13 | 14 | . Open your {product-short} application and click *Administration* > *Extensions*. 15 | . Go to the *Installed* tab to view a list of installed plugins and related information. 16 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-viewing-openshift-routes.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-viewing-openshift-routes_{context}"] 2 | = Viewing OpenShift routes 3 | 4 | .Procedure 5 | . To view OpenShift routes, grant read access to the routes resource in the Cluster Role: 6 | + 7 | [source,yaml] 8 | ---- 9 | apiVersion: rbac.authorization.k8s.io/v1 10 | kind: ClusterRole 11 | metadata: 12 | name: backstage-read-only 13 | rules: 14 | ... 15 | - apiGroups: 16 | - route.openshift.io 17 | resources: 18 | - routes 19 | verbs: 20 | - get 21 | - list 22 | ---- 23 | . Also add the following in `kubernetes.customResources` property in your `{my-app-config-file}` file: 24 | + 25 | [source,yaml] 26 | ---- 27 | kubernetes: 28 | ... 29 | customResources: 30 | - group: 'route.openshift.io' 31 | apiVersion: 'v1' 32 | plural: 'routes' 33 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-viewing-pod-logs.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-viewing-pod-logs_{context}"] 2 | = Viewing pod logs 3 | 4 | .Procedure 5 | * To view pod logs, you must grant the following permission to the `ClusterRole`: 6 | + 7 | [source,yaml] 8 | ---- 9 | apiVersion: rbac.authorization.k8s.io/v1 10 | kind: ClusterRole 11 | metadata: 12 | name: backstage-read-only 13 | rules: 14 | ... 15 | - apiGroups: 16 | - '' 17 | resources: 18 | - pods 19 | - pods/log 20 | verbs: 21 | - get 22 | - list 23 | - watch 24 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-viewing-tekton-pipelineruns.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-viewing-tekton-pipelineruns_{context}"] 2 | = Viewing Tekton PipelineRuns 3 | 4 | .Procedure 5 | . To view the Tekton PipelineRuns, grant read access to the `pipelines`, `pipelinesruns`, and `taskruns` resources in the `ClusterRole`: 6 | + 7 | [source,yaml] 8 | ---- 9 | ... 10 | apiVersion: rbac.authorization.k8s.io/v1 11 | kind: ClusterRole 12 | metadata: 13 | name: backstage-read-only 14 | rules: 15 | ... 16 | - apiGroups: 17 | - tekton.dev 18 | resources: 19 | - pipelines 20 | - pipelineruns 21 | - taskruns 22 | verbs: 23 | - get 24 | - list 25 | ---- 26 | . To view the Tekton PipelineRuns list in the side panel and the latest PipelineRuns status in the Topology node decorator, add the following code to the `kubernetes.customResources` property in your `{my-app-config-file}` file: 27 | + 28 | [source,yaml] 29 | ---- 30 | kubernetes: 31 | ... 32 | customResources: 33 | - group: 'tekton.dev' 34 | apiVersion: 'v1' 35 | plural: 'pipelines' 36 | - group: 'tekton.dev' 37 | apiVersion: 'v1' 38 | plural: 'pipelineruns' 39 | - group: 'tekton.dev' 40 | apiVersion: 'v1' 41 | plural: 'taskruns' 42 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/proc-viewing-virtual-machines.adoc: -------------------------------------------------------------------------------- 1 | [id="proc-viewing-virtual-machines_{context}"] 2 | = Viewing virtual machines 3 | 4 | .Prerequisites 5 | . The OpenShift Virtualization operator is installed and configured on a Kubernetes cluster. 6 | .Procedure 7 | . Grant read access to the `VirtualMachines` resource in the `ClusterRole`: 8 | + 9 | [source,yaml] 10 | ---- 11 | ... 12 | apiVersion: rbac.authorization.k8s.io/v1 13 | kind: ClusterRole 14 | metadata: 15 | name: backstage-read-only 16 | rules: 17 | ... 18 | - apiGroups: 19 | - kubevirt.io 20 | resources: 21 | - virtualmachines 22 | - virtualmachineinstances 23 | verbs: 24 | - get 25 | - list 26 | ---- 27 | . To view the virtual machine nodes on the topology plugin, add the following code to the `kubernetes.customResources` property in the `{my-app-config-file}` file: 28 | + 29 | [source,yaml] 30 | ---- 31 | kubernetes: 32 | ... 33 | customResources: 34 | - group: 'kubevirt.io' 35 | apiVersion: 'v1' 36 | plural: 'virtualmachines' 37 | - group: 'kubevirt.io' 38 | apiVersion: 'v1' 39 | plural: 'virtualmachineinstances' 40 | ---- -------------------------------------------------------------------------------- /modules/dynamic-plugins/ref-community-plugins.adoc: -------------------------------------------------------------------------------- 1 | // This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata. 2 | // cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html 3 | 4 | = Community plugins 5 | 6 | [IMPORTANT] 7 | ==== 8 | {product} ({product-very-short}) includes a select number of community-supported plugins, available for customers to enable and configure. These community plugins are augmented by {company-name} to be dynamic plugin capable, and are provided with support scoped per Technical Preview terms. 9 | 10 | Details on how {company-name} provides support for bundled community dynamic plugins are available on the https://access.redhat.com/policy/developerhub-support-policy[Red Hat Developer Support Policy] page. 11 | ==== 12 | 13 | {product-very-short} includes the following 0 community plugins: 14 | 15 | [%header,cols=4*] 16 | |=== 17 | |*Name* |*Plugin* |*Version* |*Path and required variables* 18 | |=== 19 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/ref-community-plugins.template.adoc: -------------------------------------------------------------------------------- 1 | // This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata. 2 | // cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html 3 | 4 | = Community plugins 5 | 6 | [IMPORTANT] 7 | ==== 8 | {product} ({product-very-short}) includes a select number of community-supported plugins, available for customers to enable and configure. These community plugins are augmented by {company-name} to be dynamic plugin capable, and are provided with support scoped per Technical Preview terms. 9 | 10 | Details on how {company-name} provides support for bundled community dynamic plugins are available on the https://access.redhat.com/policy/developerhub-support-policy[Red Hat Developer Support Policy] page. 11 | ==== 12 | 13 | {product-very-short} includes the following %%COUNT_3%% community plugins: 14 | 15 | [%header,cols=4*] 16 | |=== 17 | |*Name* |*Plugin* |*Version* |*Path and required variables* 18 | %%TABLE_CONTENT_3%% 19 | |=== 20 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/ref-rh-supported-plugins.template.adoc: -------------------------------------------------------------------------------- 1 | // This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata. 2 | // cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html 3 | 4 | = {company-name} supported plugins 5 | 6 | {company-name} supports the following %%COUNT_1%% plugins: 7 | 8 | [%header,cols=4*] 9 | |=== 10 | |*Name* |*Plugin* |*Version* |*Path and required variables* 11 | %%TABLE_CONTENT_1%% 12 | |=== 13 | -------------------------------------------------------------------------------- /modules/dynamic-plugins/ref-rh-tech-preview-plugins.template.adoc: -------------------------------------------------------------------------------- 1 | // This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata. 2 | // cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html 3 | 4 | = {company-name} Technology Preview plugins 5 | 6 | {company-name} provides Technology Preview support for the following %%COUNT_2%% plugins: 7 | 8 | [%header,cols=4*] 9 | |=== 10 | |*Name* |*Plugin* |*Version* |*Path and required variables* 11 | %%TABLE_CONTENT_2%% 12 | |=== 13 | -------------------------------------------------------------------------------- /modules/installation/con-airgapped-environment.adoc: -------------------------------------------------------------------------------- 1 | [id='con-airgapped-environment_{context}'] 2 | = Air-gapped environment 3 | 4 | An air-gapped environment, also known as an air-gapped network or isolated network, ensures security by physically segregating the system or network. This isolation is established to prevent unauthorized access, data transfer, or communication between the air-gapped system and external sources. 5 | 6 | You can install the {product} in an air-gapped environment to ensure security and meet specific regulatory requirements. 7 | -------------------------------------------------------------------------------- /modules/observe/adoption-insights/proc-configure-adoption-insights.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-configure-adoption-insights_{context}"] 3 | = Configuring the Adoption Insights plugin in {product} 4 | 5 | You can enable the Adoption Insights plugin by configuring the {product} Helm chart or the {product} Operator ConfigMap. 6 | 7 | .Procedure 8 | 9 | * To configure the Adoption Insights plugin in {product-short}, in your {product} `app-config.yaml` file, add the following code: 10 | + 11 | .`app-config.yaml` fragment 12 | [source,terminal] 13 | ---- 14 | app: 15 | analytics: 16 | adoptionInsights: 17 | maxBufferSize: 20 <1> 18 | flushInterval: 5000 <2> 19 | debug: false <3> 20 | licensedUsers: 2000 <4> 21 | ---- 22 | <1> (Optional) Specifies the maximum buffer size for event batching. The default value is `20`. 23 | <2> (Optional) Specifies the flush interval in milliseconds for event batching. The default value is `5000ms`. 24 | <3> (Optional) The default value is `false`. 25 | <4> (Optional) Specifies the maximum number of licensed users who can access the RHDH instance. The default value is `100`. -------------------------------------------------------------------------------- /modules/observe/adoption-insights/proc-filter-records-to-display-spec.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-filter-records-to-display-spec_{context}"] 3 | = Filtering records to display specific catalog entities in Top catalog entities 4 | 5 | You can use the dropdown filter in the title to filter the table display by any of the items. By default, the *Top catalog entities* card displays all of the items in your {product-short} instance. 6 | 7 | .Procedure 8 | 9 | To view a specific catalog entity in the table, complete the following step: 10 | 11 | * Go to *Administration -> Adoption Insights*, click the dropdown filter on the *Top catalog entities* card, and select the item that you want to view. -------------------------------------------------------------------------------- /modules/observe/adoption-insights/proc-setting-duration-of-data-metrics.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-setting-duration-of-data-metrics_{context}"] 3 | = Setting the duration of data metrics 4 | 5 | You can set the data metrics duration using any of the time ranges, such as *Today*, *Last week*, *Last month*, *Last 28 days* (default), *Last year*, or *Date range...*. 6 | 7 | .Procedure 8 | 9 | . On the top of the screen, click the dropdown list to display the choices. 10 | . Select the duration choice for which you want to see the data metrics. 11 | 12 | image::rhdh-plugins-reference/adoption-insights-daterange.jpg[date range] -------------------------------------------------------------------------------- /modules/observe/adoption-insights/proc-using-adoption-insights.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-using-adoption-insights_{context}"] 3 | = Using Adoption Insights in {product} 4 | 5 | In the {product-short} application, on the navigation menu, click *Administration -> Adoption Insights*. -------------------------------------------------------------------------------- /modules/observe/adoption-insights/proc-viewing-searches.adoc: -------------------------------------------------------------------------------- 1 | :_mod-docs-content-type: PROCEDURE 2 | [id="proc-viewing-searches_{context}"] 3 | = Viewing Searches 4 | 5 | In the *searches* card, you can view the following data: 6 | 7 | * Visualizes the number of portal searches and trends over time as a graph 8 | * Displays the total for the period in the card title 9 | * Clarifies the average number each hour/day/week/month depending on the time period chosen 10 | -------------------------------------------------------------------------------- /modules/observe/con-audit-log-track-changes-catalog.adoc: -------------------------------------------------------------------------------- 1 | //This content is currently part of assembly-audit-log.adoc but may need to be included as a separate module in the future 2 | 3 | :_mod-docs-content-type: CONCEPT 4 | [id="con-audit-log-track-changes-catalog_{context}"] 5 | = {product-short} catalog database changes 6 | 7 | In {product} {ocp-version-min} and later, changes to the catalog database are forwarded to a central log management system, such as ElasticSearch or Splunk by default. Administrators can view changes that add, remove, or update data in the catalog database to help ensure accountability and transparency of user actions. -------------------------------------------------------------------------------- /modules/observe/proc-audit-log-view.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // assembly-audit-log.adoc 3 | 4 | :_mod-docs-content-type: PROCEDURE 5 | [id="proc-audit-log-view_{context}"] 6 | = Viewing audit logs in {product-short} 7 | 8 | Administrators can view, search, filter, and manage the log data from the {ocp-brand-name} web console. You can filter audit logs from other log types by using the `isAuditEvent` field. 9 | 10 | .Prerequisites 11 | * You are logged in as an administrator in the {ocp-short} web console. 12 | 13 | .Procedure 14 | 15 | . From the *Developer* perspective of the {ocp-short} web console, click the *Topology* tab. 16 | . From the *Topology* view, click the pod that you want to view audit log data for. 17 | . From the pod panel, click the *Resources* tab. 18 | . From the *Pods* section of the *Resources* tab, click *View logs*. 19 | . From the *Logs* view, enter `isAuditEvent` into the *Search* field to filter audit logs from other log types. You can use the arrows to browse the logs containing the `isAuditEvent` field. 20 | -------------------------------------------------------------------------------- /modules/observe/proc-configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-helm-chart.adoc: -------------------------------------------------------------------------------- 1 | [id="configuring-annotations-for-monitoring-with-amazon-prometheus-by-using-the-helm-chart_{context}"] 2 | = Configuring annotations for monitoring with Amazon Prometheus by using the {product} Helm chart 3 | 4 | To enable logging to Amazon Prometheus, you can configure the required pod annotations by using the {product} Helm chart. 5 | 6 | .Procedure 7 | * To annotate the backstage pod for monitoring, update your `values.yaml` file as follows: 8 | + 9 | [source,yaml] 10 | ---- 11 | upstream: 12 | backstage: 13 | # --- TRUNCATED --- 14 | podAnnotations: 15 | prometheus.io/scrape: 'true' 16 | prometheus.io/path: '/metrics' 17 | prometheus.io/port: '9464' 18 | prometheus.io/scheme: 'http' 19 | ---- 20 | 21 | .Verification 22 | To verify if the scraping works: 23 | 24 | . Use `kubectl` to port-forward the Prometheus console to your local machine as follows: 25 | + 26 | [source,bash] 27 | ---- 28 | kubectl --namespace=prometheus port-forward deploy/prometheus-server 9090 29 | ---- 30 | 31 | . Open your web browser and navigate to `pass:c[http://localhost:9090]` to access the Prometheus console. 32 | 33 | . Monitor relevant metrics, such as `process_cpu_user_seconds_total`. 34 | 35 | -------------------------------------------------------------------------------- /modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-helm-chart.adoc: -------------------------------------------------------------------------------- 1 | [id="configuring-the-application-log-level-by-using-the-helm-chart_{context}"] 2 | = Configuring the application log level by using the {product} Helm chart 3 | 4 | You can configure the application log level by using the {product} Helm chart. 5 | 6 | .Procedure 7 | * Modify the logging level by adding the environment variable `LOG_LEVEL` to your Helm chart `values.yaml` file: 8 | + 9 | [source,yaml] 10 | ---- 11 | upstream: 12 | backstage: 13 | # --- Truncated --- 14 | extraEnvVars: 15 | - name: LOG_LEVEL 16 | value: debug 17 | ---- 18 | -------------------------------------------------------------------------------- /modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-operator.adoc: -------------------------------------------------------------------------------- 1 | [id="configuring-the-application-log-level-by-using-the-operator_{context}"] 2 | = Configuring the application log level by using the {product} Operator 3 | 4 | You can configure the application log level by using the {product} Operator. 5 | 6 | .Procedure 7 | * Modify the logging level by including the environment variable `LOG_LEVEL` in your custom resource as follows: 8 | + 9 | [source,yaml] 10 | ---- 11 | spec: 12 | # Other fields omitted 13 | application: 14 | extraEnvs: 15 | envs: 16 | - name: LOG_LEVEL 17 | value: debug 18 | ---- 19 | -------------------------------------------------------------------------------- /modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc: -------------------------------------------------------------------------------- 1 | [id="retrieving-logs-from-amazon-cloudwatch_{context}"] 2 | = Retrieving logs from Amazon CloudWatch 3 | 4 | .Prerequisites 5 | * CloudWatch Container Insights is used to capture logs and metrics for {eks-brand-name}. 6 | For more information, see https://docs.aws.amazon.com/prescriptive-guidance/latest/implementing-logging-monitoring-cloudwatch/kubernetes-eks-logging.html[Logging for {eks-brand-name}] documentation. 7 | 8 | * To capture the logs and metrics, link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-EKS-addon.html[install the Amazon CloudWatch Observability EKS add-on] in your cluster. 9 | Following the setup of Container Insights, you can access container logs using Logs Insights or Live Tail views. 10 | 11 | * CloudWatch names the log group where all container logs are consolidated in the following manner: 12 | + 13 | [subs="+quotes"] 14 | ---- 15 | /aws/containerinsights/__/application 16 | ---- 17 | 18 | .Procedure 19 | * To retrieve logs from the {product-short} instance, run a query such as: 20 | + 21 | [source,sql] 22 | ---- 23 | fields @timestamp, @message, kubernetes.container_name 24 | | filter kubernetes.container_name in ["install-dynamic-plugins", "backstage-backend"] 25 | ---- 26 | -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-breaking-changes.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="breaking-changes"] 3 | = Breaking changes 4 | 5 | This section lists breaking changes in {product} {product-version}. 6 | 7 | 8 | None. 9 | 10 | -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-deprecated-functionalities.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="deprecated-functionalities"] 3 | = Deprecated functionalities 4 | 5 | This section lists deprecated functionalities in {product} {product-version}. 6 | 7 | 8 | None. 9 | 10 | -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-fixed-issues.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="fixed-issues"] 3 | = Fixed issues 4 | 5 | This section lists issues fixed in {product} {product-version}. 6 | 7 | 8 | None. 9 | 10 | -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-fixed-security-issues.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="fixed-security-issues"] 3 | = Fixed security issues 4 | 5 | You can view the security issues fixed in {product} {product-version} at link:https://access.redhat.com/security/security-updates/cve?q=red+hat+developer+hub&p=1&sort=cve_publicDate+desc,allTitle+desc&rows=10&documentKind=Cve[Red Hat Security Updates]. -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-known-issues.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="known-issues"] 3 | = Known issues 4 | 5 | This section lists known issues in {product} {product-version}. 6 | 7 | 8 | None. 9 | 10 | -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-new-features.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="new-features"] 3 | = New features 4 | 5 | This section highlights new features in {product} {product-version}. 6 | 7 | None. 8 | 9 | -------------------------------------------------------------------------------- /modules/release-notes/ref-release-notes-technology-preview.adoc: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="technology-preview"] 3 | = Technology Preview 4 | 5 | This section lists Technology Preview features in {product} {product-version}. 6 | 7 | [IMPORTANT] 8 | ==== 9 | Technology Preview features provide early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process. 10 | However, these features are not fully supported under Red Hat Subscription Level Agreements, may not be functionally complete, and are not intended for production use. 11 | As Red Hat considers making future iterations of Technology Preview features generally available, we will attempt to resolve any issues that customers experience when using these features. 12 | See: link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview support scope]. 13 | ==== 14 | 15 | 16 | None. 17 | 18 | -------------------------------------------------------------------------------- /modules/release-notes/single-source-release-notes-template.adoc.jinja: -------------------------------------------------------------------------------- 1 | :_content-type: REFERENCE 2 | [id="{{ id }}"] 3 | = {{ title }} 4 | 5 | {{ introduction | default(omit) }} 6 | {% for issue in vars -%} 7 | {% if template == "with-z-stream-section" -%} 8 | {% set fixversion = issue.fields.fixVersions[0].name -%} 9 | {% if loop.previtem is not defined or fixversion != loop.previtem.fields.fixVersions[0].name -%} 10 | == {{ title }} in {{ fixversion }} 11 | {% endif %} 12 | [id="{{ issue.fields.customfield_12320850 | lower | replace(" ", "-") }}-{{ issue.key | lower }}"] 13 | == 14 | {%- else -%} 15 | [id="{{ issue.fields.customfield_12320850 | lower | replace(" ", "-") }}-{{ issue.key | lower }}"] 16 | = 17 | {%- endif -%} 18 | {{ issue.fields.customfield_12317313 }} 19 | {% if template == "with-jira-link" or template == "with-z-stream-section" %} 20 | 21 | .Additional resources 22 | * link:https://issues.redhat.com/browse/{{ issue.key }}[{{ issue.key }}] 23 | {% endif %} 24 | {% endfor %} 25 | {% if not vars -%} 26 | None. 27 | {% endif -%} 28 | -------------------------------------------------------------------------------- /modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-about-software-catalogs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-adding-new-components-to-the-rhdh-instance_{context}"] 7 | = Adding new components to your {product} instance 8 | 9 | .Prerequisites 10 | 11 | * You have installed and configured the {product} instance. 12 | * You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. 13 | 14 | .Procedure 15 | 16 | You can add components to your {product-very-short} instance using the following methods: 17 | 18 | * Register components manually using the GUI or by using your `{my-app-config-file}` with the required permissions. 19 | * Create new components by using Software Templates. 20 | * Use the bulk import plugin with the required permissions. For more information, see link:{configuring-dynamic-plugins-book-url}#bulk-importing-github-repositories[Bulk importing GitHub repositories]. -------------------------------------------------------------------------------- /modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-about-software-catalogs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-creating-new-components-in-the-rhdh-instance_{context}"] 7 | == Creating new components in your {product} instance 8 | 9 | You can create new components in the Software Catalog in your {product-very-short} instance. {product} automatically registers all components that developers or platform engineers create using Templates in the Software Catalog. 10 | 11 | .Prerequisites 12 | 13 | * You have installed and configured the {product} instance. 14 | * You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. 15 | 16 | .Procedure 17 | 18 | . In your {product} navigation menu, click *Catalog*. 19 | . On the *Catalog* page, click *Self-service*. -------------------------------------------------------------------------------- /modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-about-software-catalogs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-searching-and-filtering-software-catalogs_{context}"] 7 | = Searching and Filtering Software Catalogs 8 | 9 | You can search and filter Software Catalogs by its *Kind* or by using the *Filter* field. 10 | 11 | == Searching and Filtering Software Catalogs by Kind 12 | 13 | To filter a Software Catalog by its *Kind*, complete the following steps: 14 | 15 | .Procedure 16 | 17 | . In your {product} navigation menu, click *Catalog*. 18 | . On the *Catalog* page, click the *Kind* drop-down list. 19 | . Select the type of *Kind* you want to filter. 20 | + 21 | [NOTE] 22 | ==== 23 | The available filter dropdowns vary based on the *Kind* you select, displaying options relevant to that specific entity type. 24 | ==== 25 | 26 | == Searching and Filtering Software Catalogs using the Filter field 27 | 28 | To filter a Software Catalog using the *Filter* field, complete the following steps: 29 | 30 | .Procedure 31 | 32 | . In your {product} navigation menu, click *Catalog*. 33 | . In the *Search* box, enter the text you want to use to filter the components. -------------------------------------------------------------------------------- /modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-about-software-catalogs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-starring-components-in-the-software-catalog_{context}"] 7 | = Starring components in the Software Catalog 8 | 9 | 10 | You can use the *Add to favorites* icon to add the software catalogs that you visit regularly to the *Starred* category. 11 | 12 | .Procedure 13 | 14 | To quickly access the Software Catalogs that you visit regularly, complete the following steps: 15 | 16 | . In your {product} navigation menu, click *Catalog*. 17 | . Find the software component that you want to add as a favorite, then click the *Add to favorites* icon under *Actions*. 18 | 19 | .Verification 20 | 21 | * The starred component is listed under *Your Starred Entities* on your *Home* page. -------------------------------------------------------------------------------- /modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-about-software-catalogs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-updating-components-in-the-software-catalog_{context}"] 7 | = Updating components in the Software Catalog in your {product} instance 8 | 9 | You can update components in the Software Catalog in your {product} instance. 10 | 11 | .Prerequisites 12 | 13 | * You have installed and configured the {product} instance. 14 | * You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. 15 | 16 | .Procedure 17 | 18 | To update components in the Software Catalog in your {product} instance, complete the following steps: 19 | 20 | . In your {product} navigation menu, click *Catalog*. 21 | . Find the software component that you want to edit, then click the *Edit* icon under *Actions*. 22 | 23 | + 24 | [NOTE] 25 | ==== 26 | This action redirects you to the YAML file on GitHub. 27 | ==== 28 | 29 | . On your remote repository UI, update your YAML file. 30 | 31 | + 32 | [NOTE] 33 | ==== 34 | After you merge your changes, the updated metadata in the Software Catalog appears after some time. 35 | ==== -------------------------------------------------------------------------------- /modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-about-software-catalogs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-viewing-software-catalog-yaml_{context}"] 7 | = Viewing the Software Catalog YAML file in your {product} instance 8 | 9 | You can view the Software Catalog YAML file in your {product} instance. The YAML file displays the metadata for the components in your Software Catalog. 10 | 11 | .Procedure 12 | 13 | To view the Software Catalog YAML file in your {product} instance, complete the following steps: 14 | 15 | . In your {product} navigation menu, click *Catalog*. 16 | . Find the software component that you want to view, then click the *View* icon under *Actions*. 17 | 18 | + 19 | [NOTE] 20 | ==== 21 | These steps redirect you to the YAML file on your remote repository. 22 | ==== -------------------------------------------------------------------------------- /modules/techdocs/proc-techdocs-addon-use-light-box.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-techdocs-addons-using.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-techdocs-addon-use-light-box_{context}"] 7 | == Using the LightBox TechDocs add-on 8 | 9 | If your TechDocs documentation contains an image, you can use the `LightBox` add-on to view an enlarged version of the image in a lightbox, or overlay window. You can also zoom to change the size the lightbox image. If a single documentation page contains multiple images, you can navigate between images in the lightbox. 10 | 11 | .Prerequisites 12 | * The `LightBox` add-on is installed and enabled in your TechDocs plugin. 13 | 14 | .Procedure 15 | . In your TechDocs documentation, click on the image that you want to view in a lightbox. 16 | . In the lightbox, you can do any of the following actions: 17 | * Click the image or scroll to zoom in or zoom out. 18 | * Click the arrow to navigate between images. 19 | -------------------------------------------------------------------------------- /modules/techdocs/proc-techdocs-addon-use-text-size.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-techdocs-addons-using.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-techdocs-addon-use-text-size_{context}"] 7 | == Using the TextSize TechDocs add-on 8 | 9 | You can use the `TextSize` add-on to change the size of the text on either the TechDocs Reader page or an Entity page. 10 | 11 | .Prerequisites 12 | * The `TextSize` add-on is installed and enabled in your TechDocs plugin. 13 | 14 | .Procedure 15 | . In your TechDocs header, click the *Settings* icon. 16 | . Use the sliding scale to adjust the size of your documentation text. 17 | + 18 | [NOTE] 19 | ==== 20 | * The default text size is 100% 21 | * The minimize text size is 90% 22 | * The maximum text size is 150% 23 | ==== 24 | -------------------------------------------------------------------------------- /modules/techdocs/proc-techdocs-edit-docs.adoc: -------------------------------------------------------------------------------- 1 | // Module included in the following assemblies: 2 | // 3 | // * assemblies/assembly-using-techdocs.adoc 4 | 5 | :_mod-docs-content-type: PROCEDURE 6 | [id="proc-techdocs-edit-docs_{context}"] 7 | = Editing documentation in TechDocs 8 | 9 | You can edit a document in your TechDocs plugin directly from the document book page. Any authorized user in your organization can edit a document regardless of whether or not they are the owner of the document. 10 | 11 | .Procedure 12 | 13 | . In the {product} navigation menu, click *Docs*. 14 | . In the *Documentation* table, click the name of the document that you want to edit. 15 | . In the document, click the *Edit this page* icon to open the document in your remote repository. 16 | . In your remote repository, edit the document as needed. 17 | . Use the repository provider UI and your usual team processes to commit and merge your changes. 18 | -------------------------------------------------------------------------------- /modules/using-kubernetes-custom-actions/proc-enable-kubernetes-custom-actions-plugin.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-enable-kubernetes-custom-actions-plugin_{context}'] 2 | = Enabling Kubernetes custom actions plugin in {product} 3 | 4 | In {product}, the Kubernetes custom actions are provided as a preinstalled plugin, which is disabled by default. You can enable the Kubernetes custom actions plugin by updating the `disabled` key value in your Helm chart. 5 | 6 | .Prerequisites 7 | 8 | * You have installed {product} with the Helm chart. 9 | 10 | .Procedure 11 | 12 | To enable the Kubernetes custom actions plugin, complete the following step: 13 | 14 | * In your Helm chart, add a `package` with the Kubernetes custom action plugin name and update the `disabled` field. For example: 15 | + 16 | -- 17 | [source,yaml] 18 | ---- 19 | global: 20 | dynamic: 21 | includes: 22 | - dynamic-plugins.default.yaml 23 | plugins: 24 | - package: ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-kubernetes-dynamic 25 | disabled: false 26 | ---- 27 | 28 | [NOTE] 29 | ==== 30 | The default configuration for a plugin is extracted from the `dynamic-plugins.default.yaml` file, however, you can use a `pluginConfig` entry to override the default configuration. 31 | ==== 32 | -- 33 | -------------------------------------------------------------------------------- /modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc: -------------------------------------------------------------------------------- 1 | [id='proc-using-kubernetes-custom-actions-plugin_{context}'] 2 | = Using Kubernetes custom actions plugin in {product} 3 | 4 | In {product}, the Kubernetes custom actions enable you to run template actions for Kubernetes. 5 | 6 | .Procedure 7 | 8 | * To use a Kubernetes custom action in your custom template, add the following Kubernetes actions to your template: 9 | + 10 | 11 | [source,yaml,subs="+attributes"] 12 | ---- 13 | action: kubernetes:create-namespace 14 | id: create-kubernetes-namespace 15 | name: Create kubernetes namespace 16 | input: 17 | namespace: {my-product-namespace} 18 | clusterRef: bar 19 | token: TOKEN 20 | skipTLSVerify: false 21 | caData: Zm9v 22 | labels: app.io/type=ns; app.io/managed-by=org; 23 | 24 | ---- 25 | 26 | [role="_additional-resources"] 27 | .Additional resource 28 | 29 | * link:{customizing-book-url#configuring-templates}[Configuring templates]. -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Jinja2>=3.1.4 2 | jira>=3.8.0 3 | pip>=21.3.1 4 | pyyaml>=6.0.2 5 | tox>=4.21.0 6 | setuptools 7 | -------------------------------------------------------------------------------- /titles/about/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/about/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/about/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/about/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/about/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-about_red_hat_developer_hub"] 2 | include::artifacts/attributes.adoc[] 3 | :imagesdir: images 4 | :title: About {product} 5 | :subtitle: {product} is a customizable developer portal with enterprise-level support and a centralized software catalog that you can use to build high-quality software efficiently in a streamlined development environment. 6 | :abstract: {product} is a customizable developer portal with enterprise-level support and a centralized software catalog that you can use to build high-quality software efficiently in a streamlined development environment. 7 | 8 | include::assemblies/assembly-about-rhdh.adoc[] 9 | 10 | [role="_next-steps"] 11 | .Next steps 12 | * link:{installing-on-eks-book-url}[{installing-on-eks-book-title}] 13 | * link:{installing-on-osd-on-gcp-book-url}[{installing-on-osd-on-gcp-book-title}] 14 | * link:{installing-on-gke-book-url}[{installing-on-gke-book-title}] 15 | * link:{installing-on-aks-book-url}[{installing-on-aks-book-title}] 16 | * link:{installing-on-ocp-book-url}[{installing-on-ocp-book-title}] 17 | 18 | -------------------------------------------------------------------------------- /titles/about/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/adoption-insights/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/adoption-insights/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/adoption-insights/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/adoption-insights/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/adoption-insights/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-adoption-insights 3 | :imagesdir: images 4 | :title: Adoption Insights in {product} 5 | :subtitle: Delivers detailed analytics on adoption and engagement within your internal developer portal. 6 | :abstract: As a platform engineer, you can configure Adoption Insights in {product-very-short} to visualize key metrics and trends to get information about the usage of {product-very-short} in your organization. 7 | = {title} 8 | 9 | //{product} Adoption Insights (Developer Preview) 10 | include::assemblies/assembly-adoption-insights.adoc[leveloffset=+1] 11 | -------------------------------------------------------------------------------- /titles/adoption-insights/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/audit-log/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/audit-log/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/audit-log/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/audit-log/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/audit-log/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-audit-log 3 | :imagesdir: images 4 | :title: Audit logs in {product} 5 | :subtitle: Tracking user activities, system events, and data changes with {product} audit logs 6 | :abstract: As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs. 7 | = {title} 8 | 9 | // Audit logging 10 | include::assemblies/assembly-audit-log.adoc[leveloffset=+1] 11 | -------------------------------------------------------------------------------- /titles/audit-log/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/authentication/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/authentication/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/authentication/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/authentication/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/authentication/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-authentication 3 | :imagesdir: images 4 | :title: Authentication in {product} 5 | :subtitle: Configuring authentication to external services in {product} 6 | :abstract: As a {product} platform engineer, you can manage authentication of other users to meet the specific needs of your organization. 7 | //[id="{context}"] 8 | //= {title} 9 | 10 | //{abstract} 11 | 12 | include::assemblies/assembly-enabling-authentication.adoc[] 13 | -------------------------------------------------------------------------------- /titles/authentication/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/authorization/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/authorization/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/authorization/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/authorization/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/authorization/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-authorization 3 | :imagesdir: images 4 | :title: Authorization in {product} 5 | :subtitle: Configuring authorization by using role based access control (RBAC) in {product} 6 | :abstract: {product} administrators can use role-based access control (RBAC) to manage authorizations of other users. 7 | //[id="{context}"] 8 | //= {title} 9 | 10 | //{abstract} 11 | 12 | include::assemblies/assembly-configuring-authorization-in-rhdh.adoc[] 13 | -------------------------------------------------------------------------------- /titles/authorization/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/configuring/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts/ -------------------------------------------------------------------------------- /titles/configuring/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies/ -------------------------------------------------------------------------------- /titles/configuring/docinfo.xml: -------------------------------------------------------------------------------- 1 | ../../artifacts/docinfo.xml -------------------------------------------------------------------------------- /titles/configuring/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/configuring/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/customizing/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts/ -------------------------------------------------------------------------------- /titles/customizing/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies/ -------------------------------------------------------------------------------- /titles/customizing/docinfo.xml: -------------------------------------------------------------------------------- 1 | ../../artifacts/docinfo.xml -------------------------------------------------------------------------------- /titles/customizing/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/customizing/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/install-rhdh-air-gapped/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/install-rhdh-air-gapped/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/install-rhdh-air-gapped/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 13 | -------------------------------------------------------------------------------- /titles/install-rhdh-air-gapped/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/install-rhdh-air-gapped/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-install-rhdh-air-grapped"] 2 | include::artifacts/attributes.adoc[] 3 | :title: Installing {product} in an air-gapped environment 4 | :subtitle: Running {product} on {ocp-brand-name} in a networik restricted environment by using either the Operator or Helm chart 5 | :abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy an air-gapped {product-short} instance on any supported platform using either the Operator or Helm chart 6 | = {title} 7 | :context: title-install-rhdh-air-grapped 8 | :imagesdir: images 9 | 10 | include::modules/installation/con-airgapped-environment.adoc[leveloffset=+1] 11 | 12 | // OCP 13 | include::assemblies/assembly-install-rhdh-airgapped-environment-ocp-operator.adoc[leveloffset=+1] 14 | 15 | include::assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc[leveloffset=+1] 16 | 17 | // Kubernetes 18 | include::assemblies/assembly-install-rhdh-airgapped-environment-k8s-helm.adoc[leveloffset=+1] 19 | -------------------------------------------------------------------------------- /titles/install-rhdh-air-gapped/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/install-rhdh-aks/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/install-rhdh-aks/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/install-rhdh-aks/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/install-rhdh-aks/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/install-rhdh-aks/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-install-rhdh-aks"] 2 | include::artifacts/attributes.adoc[] 3 | :title: Installing {product} on {aks-brand-name} 4 | :subtitle: Running {product} on {aks-brand-name} ({aks-short}) by using either the Operator or Helm chart. 5 | :abstract: {product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {aks-brand-name} ({aks-short}) using either the Operator or Helm chart. 6 | = {title} 7 | :context: title-install-rhdh-aks 8 | :imagesdir: images 9 | 10 | // aks deployment 11 | //include::assemblies/assembly-install-rhdh-aks.adoc[leveloffset=+1] //RHIDP-4165: multi-chapter format 12 | 13 | You can install {product} on {aks-brand-name} ({aks-short}) using one of the following methods: 14 | 15 | * The {product} Operator 16 | * The {product} Helm chart 17 | 18 | // Operator method 19 | include::modules/installation/proc-rhdh-deploy-aks-operator.adoc[leveloffset=+1] 20 | 21 | // Helm chart method 22 | include::modules/installation/proc-rhdh-deploy-aks-helm.adoc[leveloffset=+1] 23 | 24 | -------------------------------------------------------------------------------- /titles/install-rhdh-aks/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/install-rhdh-eks/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/install-rhdh-eks/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/install-rhdh-eks/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/install-rhdh-eks/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/install-rhdh-eks/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-install-rhdh-eks"] 2 | include::artifacts/attributes.adoc[] 3 | :title: Installing {product} on {eks-brand-name} 4 | :subtitle: Running {product} on {eks-brand-name} ({eks-short}) by using either the Operator or Helm chart 5 | :abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {eks-brand-name} ({eks-short}) using either the Operator or Helm chart. 6 | = {title} 7 | :context: title-install-rhdh-eks 8 | :imagesdir: images 9 | 10 | // aws eks deployment 11 | //include::assemblies/assembly-install-rhdh-eks.adoc[leveloffset=+1] //RHIDP-4165: multi-chapter format 12 | 13 | You can install {product} on {eks-brand-name} ({eks-short}) using one of the following methods: 14 | 15 | * The {product} Operator 16 | * The {product} Helm chart 17 | 18 | // Operator method 19 | include::assemblies/assembly-install-rhdh-eks-operator.adoc[leveloffset=+1] 20 | 21 | include::modules/installation/proc-deploy-rhdh-instance-eks.adoc[leveloffset=+2] 22 | 23 | // Helm chart method 24 | include::modules/installation/proc-rhdh-deploy-eks-helm.adoc[leveloffset=+1] 25 | -------------------------------------------------------------------------------- /titles/install-rhdh-eks/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/install-rhdh-gke/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/install-rhdh-gke/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/install-rhdh-gke/docinfo.xml: -------------------------------------------------------------------------------- 1 | Installing {product} on {gke-brand-name} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/install-rhdh-gke/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/install-rhdh-gke/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-install-rhdh-gke"] 2 | include::artifacts/attributes.adoc[] 3 | :title: Installing {product} on {gke-brand-name} 4 | :subtitle: Running {product} on {gke-brand-name} ({gke-short}) by using either the Operator or Helm chart. 5 | :abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {gke-brand-name} ({gke-short}) using either the Operator or Helm chart. 6 | = {title} 7 | :context: title-install-rhdh-gke 8 | :imagesdir: images 9 | 10 | // Google gke deployment - is this required for 1.4 release [TBC] 11 | //include::assemblies/assembly-install-rhdh-gke.adoc[leveloffset=+1] //RHIDP-4165: multi-chapter format 12 | 13 | You can install {product} on {gke-brand-name} ({gke-short}) using one of the following methods: 14 | 15 | * The {product} Operator 16 | * The {product} Helm chart 17 | 18 | // Operator method 19 | include::modules/installation/proc-rhdh-deploy-gke-operator.adoc[leveloffset=+1] 20 | 21 | include::modules/installation/proc-deploy-rhdh-instance-gke.adoc[leveloffset=+2] 22 | 23 | // Helm chart method 24 | include::modules/installation/proc-rhdh-deploy-gke-helm.adoc[leveloffset=+1] 25 | -------------------------------------------------------------------------------- /titles/install-rhdh-gke/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/install-rhdh-ocp/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/install-rhdh-ocp/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/install-rhdh-ocp/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/install-rhdh-ocp/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/install-rhdh-ocp/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/install-rhdh-osd-gcp/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/install-rhdh-osd-gcp/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/install-rhdh-osd-gcp/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/install-rhdh-osd-gcp/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/install-rhdh-osd-gcp/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-install-rhdh-osd-gcp"] 2 | include::artifacts/attributes.adoc[] 3 | :title: Installing {product} on {osd-short} on {gcp-brand-name} 4 | :subtitle: Running {product} on {osd-brand-name} by using either the Operator or Helm chart. 5 | :abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {osd-brand-name} on {gcp-brand-name} ({gcp-short}) using either the Operator or Helm chart. 6 | = {title} 7 | :context: title-install-rhdh-osd-gcp 8 | :imagesdir: images 9 | 10 | You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using one of the following methods: 11 | 12 | * The {product} Operator 13 | * The {product} Helm chart 14 | 15 | // Operator procedure 16 | include::modules/installation/proc-install-rhdh-osd-gcp-operator.adoc[leveloffset=+1] 17 | 18 | // Helm procedure 19 | include::modules/installation/proc-install-rhdh-osd-gcp-helm.adoc[leveloffset=+1] 20 | -------------------------------------------------------------------------------- /titles/install-rhdh-osd-gcp/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/monitoring-and-logging/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/monitoring-and-logging/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/monitoring-and-logging/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/monitoring-and-logging/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/monitoring-and-logging/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-monitoring-logging 3 | :imagesdir: images 4 | :title: Monitoring and logging 5 | :subtitle: Tracking performance and capturing insights with monitoring and logging tools in {product} 6 | :abstract: As a {product} Operations or Project Manager, you can monitor performance and gather insights using {product}'s monitoring and logging tools. 7 | 8 | = {title} 9 | 10 | //metrics 11 | include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] 12 | 13 | //AWS 14 | include::assemblies/assembly-monitoring-and-logging-with-aws.adoc[leveloffset=+1] 15 | 16 | //AKS 17 | include::assemblies/assembly-monitoring-and-logging-aks.adoc[leveloffset=+1] 18 | 19 | -------------------------------------------------------------------------------- /titles/monitoring-and-logging/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/plugin-rhdh/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugin-rhdh/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugin-rhdh/docinfo.xml: -------------------------------------------------------------------------------- 1 | Configuring plugins in {product} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | Red Hat Developer Hub is a developer platform for building developer portals. You can add and configure plugins in {product-short} to access various software development tools. 8 | 9 | 10 | Red Hat Customer Content Services 11 | 12 | 13 | -------------------------------------------------------------------------------- /titles/plugin-rhdh/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugin-rhdh/master.adoc: -------------------------------------------------------------------------------- 1 | include::title-plugin.adoc[] -------------------------------------------------------------------------------- /titles/plugin-rhdh/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/plugins-rhdh-about/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugins-rhdh-about/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugins-rhdh-about/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | The {product} ({product-very-short}) application offers a unified platform with various plugins. Using the plugin ecosystem within the {product-short} application, you can access your development infrastructure and software development tools. 8 | 9 | 10 | 11 | {company-name} Customer Content Services 12 | 13 | 15 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-about/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugins-rhdh-about/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-plugins-rhdh-about"] 2 | include::artifacts/attributes.adoc[] 3 | :context: title-plugins-rhdh-about 4 | :imagesdir: images 5 | :title: Introduction to plugins 6 | :subtitle: Introduction to {product-very-short} plugins 7 | :abstract: As a {product} user, you can learn about {product} plugins. 8 | 9 | = Introduction to plugins 10 | include::modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1] 11 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-about/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/plugins-rhdh-configure/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugins-rhdh-configure/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugins-rhdh-configure/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-configure/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugins-rhdh-configure/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-plugins-rhdh-configure 3 | :imagesdir: images 4 | 5 | :title: Configuring dynamic plugins 6 | :subtitle: Configuring dynamic plugins in {product} 7 | :abstract: As a platform engineer, you can configure dynamic plugins in {product-very-short} to access your development infrastructure or software development tools. 8 | 9 | include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[] 10 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-configure/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/plugins-rhdh-install/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugins-rhdh-install/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugins-rhdh-install/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-install/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugins-rhdh-install/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-plugins-rhdh-about 3 | :imagesdir: images 4 | 5 | :title: Installing and viewing plugins in {product} 6 | :subtitle: Installing plugins in {product} 7 | :abstract: Administrative users can install and configure plugins to enable other users to use plugins to extend {product-very-short} functionality. 8 | 9 | = {title} 10 | 11 | //installing dynamic plugins 12 | include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[leveloffset=+1] 13 | 14 | //third-party plugins 15 | include::assemblies/dynamic-plugins/assembly-third-party-plugins.adoc[leveloffset=+1] 16 | 17 | //Install RHDH container image plugins 18 | include::modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc[leveloffset=+1] 19 | 20 | // Viewing installed plugins - moved to Extensions 21 | //include::modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1] 22 | 23 | // Extensions (marketplace) plugins 24 | include::assemblies/dynamic-plugins/assembly-extensions-plugins.adoc[leveloffset=+1] 25 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-install/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/plugins-rhdh-reference/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugins-rhdh-reference/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugins-rhdh-reference/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-reference/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugins-rhdh-reference/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-plugins-rhdh-about 3 | :imagesdir: images 4 | 5 | :title: Dynamic plugins reference 6 | :subtitle: {product} is preinstalled with a selection of dynamic plugins that you can enable and configure to extend {product-short} functionality 7 | :abstract: {product} is preinstalled with a selection of dynamic plugins that users can enable and configure to extend {product-very-short} functionality. 8 | 9 | include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[] 10 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-reference/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/plugins-rhdh-troubleshooting/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugins-rhdh-troubleshooting/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugins-rhdh-troubleshooting/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-troubleshooting/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugins-rhdh-troubleshooting/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-plugins-rhdh-about 3 | :imagesdir: images 4 | :title: Troubleshooting {product} plugins 5 | :subtitle: Troubleshooting {product-very-short} plugins 6 | :abstract: This document describes how to resolve common problems with {product}. 7 | //[id="{context}"] 8 | //= {title} 9 | 10 | //{abstract} 11 | 12 | include::assemblies/dynamic-plugins/assembly-troubleshooting-rhdh-plugins.adoc[] 13 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-troubleshooting/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/plugins-rhdh-using/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/plugins-rhdh-using/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/plugins-rhdh-using/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-using/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/plugins-rhdh-using/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-plugins-rhdh-using 3 | :imagesdir: images 4 | :title: Using dynamic plugins in {product} 5 | :subtitle: Using {product} plugins to access your development infrastructure and software development tools. 6 | :abstract: The following sections provide information about how you can use {product-very-short} dynamic plugins. 7 | //[id="{context}"] 8 | //= {title} 9 | 10 | //{abstract} 11 | 12 | include::assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc[] 13 | -------------------------------------------------------------------------------- /titles/plugins-rhdh-using/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/rel-notes-rhdh/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/rel-notes-rhdh/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/rel-notes-rhdh/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/rel-notes-rhdh/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/rel-notes-rhdh/master.adoc: -------------------------------------------------------------------------------- 1 | include::title-rhdh-release-notes.adoc[] -------------------------------------------------------------------------------- /titles/rel-notes-rhdh/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/techdocs/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/techdocs/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/techdocs/docinfo.xml: -------------------------------------------------------------------------------- 1 | TechDocs for {product} 2 | {product} 3 | {product-version} 4 | Use the TechDocs plugin to read and manage your team's technical documentation in one place. Further enhance and customize your TechDocs experience with add-ons. 5 | 6 | Your organization can use the built-in TechDocs plugin for {product} to create, find, and use technical documentation in a central location and in a standardized way. Documentation files are stored alongside your code and rendered in the Docs tab. Use supported TechDocs add-ons, or create your own, to further enhance your documentation experience. 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 13 | -------------------------------------------------------------------------------- /titles/techdocs/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/techdocs/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | 3 | :context: customizing-display 4 | [id="{context}"] 5 | = TechDocs for {product} 6 | 7 | // about techdocs 8 | include::modules/techdocs/con-techdocs-about.adoc[leveloffset=+1] 9 | 10 | // techdocs configuration 11 | include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1] 12 | 13 | // using techdocs 14 | include::assemblies/assembly-using-techdocs.adoc[leveloffset=+1] 15 | 16 | // techdocs add-ons 17 | include::assemblies/assembly-techdocs-addons.adoc[leveloffset=+1] 18 | 19 | include::assemblies/assembly-techdocs-addons-installing.adoc[leveloffset=+2] 20 | 21 | include::assemblies/assembly-techdocs-addons-removing.adoc[leveloffset=+2] 22 | 23 | include::assemblies/assembly-techdocs-addons-using.adoc[leveloffset=+2] 24 | 25 | include::modules/techdocs/proc-techdocs-addon-create.adoc[leveloffset=+1] 26 | -------------------------------------------------------------------------------- /titles/techdocs/modules: -------------------------------------------------------------------------------- 1 | ../../modules -------------------------------------------------------------------------------- /titles/telemetry/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/telemetry/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/telemetry/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | {abstract} 7 | 8 | 9 | {company-name} Customer Content Services 10 | 11 | 12 | -------------------------------------------------------------------------------- /titles/telemetry/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/telemetry/master.adoc: -------------------------------------------------------------------------------- 1 | include::artifacts/attributes.adoc[] 2 | :context: title-telemetry 3 | :imagesdir: images 4 | :title: Telemetry data collection and analysis 5 | :subtitle: Collecting and analyzing web analytics and system observability data to enhance {product} experience 6 | :abstract: As a {product} administrator, you can collect and analyze two distinct types of telemetry data: web analytics using Segment and system observability using OpenTelemetry, to enhance the {product} experience. 7 | 8 | = {title} 9 | 10 | //Telemetry data collection and analysis 11 | include::modules/analytics/con-telemetry-data-collection-and-analysis.adoc[leveloffset=+1] 12 | 13 | // disabling telemetry 14 | include::assemblies/assembly-disabling-telemetry-data-collection.adoc[leveloffset=+1] 15 | 16 | // enabling telemetry 17 | include::assemblies/assembly-enabling-telemetry-data-collection.adoc[leveloffset=+1] 18 | 19 | // customizing segment source 20 | include::assemblies/assembly-customizing-segment-source.adoc[leveloffset=+1] -------------------------------------------------------------------------------- /titles/telemetry/modules: -------------------------------------------------------------------------------- 1 | ../../modules/ -------------------------------------------------------------------------------- /titles/upgrade-rhdh/artifacts: -------------------------------------------------------------------------------- 1 | ../../artifacts -------------------------------------------------------------------------------- /titles/upgrade-rhdh/assemblies: -------------------------------------------------------------------------------- 1 | ../../assemblies -------------------------------------------------------------------------------- /titles/upgrade-rhdh/docinfo.xml: -------------------------------------------------------------------------------- 1 | {title} 2 | {product} 3 | {product-version} 4 | {subtitle} 5 | 6 | 7 | {abstract} 8 | 9 | 10 | {company-name} Customer Content Services 11 | 12 | 14 | -------------------------------------------------------------------------------- /titles/upgrade-rhdh/images: -------------------------------------------------------------------------------- 1 | ../../images -------------------------------------------------------------------------------- /titles/upgrade-rhdh/master.adoc: -------------------------------------------------------------------------------- 1 | [id="title-upgrade-rhdh"] 2 | include::artifacts/attributes.adoc[] 3 | :title: Upgrading {product} 4 | :subtitle: Upgrading a {product} instance to a later version by using either the Operator or the Helm chart 5 | :abstract: You can upgrade a {product} instance to a later version from the {ocp-short} web console using either the Operator or the Helm chart. 6 | :context: title-upgrade-rhdh 7 | :imagesdir: images 8 | = {title} 9 | 10 | include::modules/upgrade/proc-upgrade-rhdh-operator.adoc[leveloffset=+1] 11 | 12 | include::modules/upgrade/proc-upgrade-rhdh-helm.adoc[leveloffset=+1] 13 | -------------------------------------------------------------------------------- /titles/upgrade-rhdh/modules: -------------------------------------------------------------------------------- 1 | ../../modules --------------------------------------------------------------------------------