diff --git a/docs/user-guide/install-configure-zos-extensions.md b/docs/user-guide/install-configure-zos-extensions.md index af8d1ff763..a721c64478 100644 --- a/docs/user-guide/install-configure-zos-extensions.md +++ b/docs/user-guide/install-configure-zos-extensions.md @@ -1,4 +1,4 @@ -# Zowe server component and extension management +# Server Component and Extension Management This page covers how to install and manage Zowe server components or extensions by using `zwe components` commands. @@ -34,6 +34,15 @@ More information such as parameters and examples can be found on the [`zwe compo ## Enable and disable component +Each component and extension of Zowe can be enabled or disabled by changing the value of the `enabled` property of their object in the Zowe configuration YAML. +For example, to enable or disable the API Catalog, set this value to `true` or `false` in the YAML: + +```yaml +components: + api-catalog: + enabled: true +``` + Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and [`zwe components disable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) commands to help you enable and disable Zowe server component (extension). In order to be compatible with these commands, components must follow [Zowe server component package format standard](../extend/packaging-zos-extensions.md#zowe-server-component-package-format). **Important** these commands will update your `zowe.yaml` configuration file. @@ -42,6 +51,22 @@ Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zw More information such as parameters and examples can be found on the [`zwe components enable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and the [`zwe components disable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) +### Limiting Zowe to specific service groups + +Zowe's server installation contains groups of components that are useful to run together, but often you do not need to enable all parts of Zowe. +You can save system resources by disabling the parts of Zowe that you do not use. + +| Category | Component | Purpose | +|------|------|------| +| API Mediation Layer | api-catalog | Used to view API swagger / openAPI specifications for registered API services of the API Mediation Layer. +| API Mediation Layer | discovery | This server is used to register API services and track the health of them for use in the API Mediation Layer. +| API Mediation Layer | gateway | The gateway unifies all the services of Zowe under one proxied server for improved security, management, and high availability. +| API Mediation Layer | caching-service | The caching service is used to share state between different Zowe instances in a high availability topology. +| API Mediation Layer | zaas | ZAAS provides authentication services used by the API Mediation Layer. +| App Framework | app-server | The App server powers the Zowe Desktop accessible via web browsers. +| App Framework | zss | Z Secure Services (ZSS) provides REST API services for file, dataset, and other z/OS content. Its APIs are used by apps in the Desktop, such as the the File Editor. + + ## Upgrading a component `zwe components install` is only used for installing a component that is not yet installed. diff --git a/docs/user-guide/installandconfig.md b/docs/user-guide/installandconfig.md index bf0bc84c34..a6c3720abd 100755 --- a/docs/user-guide/installandconfig.md +++ b/docs/user-guide/installandconfig.md @@ -62,9 +62,7 @@ During execution of Zowe, the runtime directory contents are not modified. Maint - To start the API Mediation Layer as a standalone component, see [API Mediation Layer as a standalone component](./api-mediation/configuration-api-mediation-standalone.md). - - If you plan to use API ML with basic authentication and JSON web token authentication, you need to run only `ZWESLSTC`. No need to run `ZWESISTC` and `ZWESASTC`. - - - If you plan to use API ML with x509 client-side certificate authentication, you need to run `ZWESISTC` and `ZWESLSTC`. + - If you plan to use only the API ML components and you will not be using x509 client-side certificate authentication, you do not need to run or set up ZWESISTC and ZWESASTC. Only ZWESLSTC will be used. ## Topology of the Zowe z/OS launch process @@ -271,4 +269,4 @@ Zowe uses [`zwe components install` command](../appendix/zwe_server_command_refe ## Next step -Review and address the specific requirements in the Prepare for Installation section before beginning installation of Zowe server-side components for z/OS. \ No newline at end of file +Review and address the specific requirements in the Prepare for Installation section before beginning installation of Zowe server-side components for z/OS. diff --git a/sidebars.js b/sidebars.js index 65fb42749d..a59ee2b523 100644 --- a/sidebars.js +++ b/sidebars.js @@ -244,12 +244,7 @@ module.exports = { } ] }, - { - type: "category", - label: "Starting and stopping Zowe", - link: { type: "doc", id: "user-guide/start-zowe-zos" }, - items: ["user-guide/api-mediation/configuration-api-mediation-standalone"] - }, + "user-guide/start-zowe-zos", "user-guide/verify-zowe-runtime-install", { type: "category", diff --git a/versioned_docs/version-v2.15.x/user-guide/install-configure-zos-extensions.md b/versioned_docs/version-v2.15.x/user-guide/install-configure-zos-extensions.md index 48970663ff..e6ff5096c1 100644 --- a/versioned_docs/version-v2.15.x/user-guide/install-configure-zos-extensions.md +++ b/versioned_docs/version-v2.15.x/user-guide/install-configure-zos-extensions.md @@ -34,6 +34,15 @@ More information such as parameters and examples can be found on the [`zwe compo ## Enable and disable component +Each component and extension of Zowe can be enabled or disabled by changing the value of the "enabled" property of their object in the Zowe configuration YAML. +For example, if you wish to enable or disable the API Catalog, it would be accomplished by setting this value in the YAML: + +```yaml +components: + api-catalog: + enabled: true +``` + Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and [`zwe components disable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) commands to help you enable and disable Zowe server component (extension). In order to be compatible with these commands, components must follow [Zowe server component package format standard](../extend/packaging-zos-extensions.md#zowe-server-component-package-format). **Important** these commands will update your `zowe.yaml` configuration file. @@ -42,6 +51,21 @@ Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zw More information such as parameters and examples can be found on the [`zwe components enable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and the [`zwe components disable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) +### Limiting Zowe to specific service groups + +Zowe's server installation contains groups of components that are useful to run together, but often you do not need to enable all parts of Zowe. +You can save system resources by disabling the parts of Zowe that you do not use. + +| Category | Component | Purpose | +|------|------|------| +| API Mediation Layer | api-catalog | Used to view API swagger / openAPI specifications for registered API services of the API Mediation Layer. +| API Mediation Layer | discovery | This server is used to register API services and track the health of them for use in the API Mediation Layer. +| API Mediation Layer | gateway | The gateway unifies all the services of Zowe under one proxied server for improved security, management, and high availability. +| API Mediation Layer | caching-service | The caching service is used to share state between different Zowe instances in a high availability topology. +| App Framework | app-server | The App server powers the Zowe Desktop accessible via web browsers. +| App Framework | zss | Z Secure Services (ZSS) provides REST API services for file, dataset, and other z/OS content. Its APIs are used by apps in the Desktop, such as the the File Editor. + + ## Upgrading a component `zwe components install` is only used for installing a component that is not yet installed. diff --git a/versioned_docs/version-v2.16.x/user-guide/install-configure-zos-extensions.md b/versioned_docs/version-v2.16.x/user-guide/install-configure-zos-extensions.md index 48970663ff..e6ff5096c1 100644 --- a/versioned_docs/version-v2.16.x/user-guide/install-configure-zos-extensions.md +++ b/versioned_docs/version-v2.16.x/user-guide/install-configure-zos-extensions.md @@ -34,6 +34,15 @@ More information such as parameters and examples can be found on the [`zwe compo ## Enable and disable component +Each component and extension of Zowe can be enabled or disabled by changing the value of the "enabled" property of their object in the Zowe configuration YAML. +For example, if you wish to enable or disable the API Catalog, it would be accomplished by setting this value in the YAML: + +```yaml +components: + api-catalog: + enabled: true +``` + Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and [`zwe components disable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) commands to help you enable and disable Zowe server component (extension). In order to be compatible with these commands, components must follow [Zowe server component package format standard](../extend/packaging-zos-extensions.md#zowe-server-component-package-format). **Important** these commands will update your `zowe.yaml` configuration file. @@ -42,6 +51,21 @@ Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zw More information such as parameters and examples can be found on the [`zwe components enable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and the [`zwe components disable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) +### Limiting Zowe to specific service groups + +Zowe's server installation contains groups of components that are useful to run together, but often you do not need to enable all parts of Zowe. +You can save system resources by disabling the parts of Zowe that you do not use. + +| Category | Component | Purpose | +|------|------|------| +| API Mediation Layer | api-catalog | Used to view API swagger / openAPI specifications for registered API services of the API Mediation Layer. +| API Mediation Layer | discovery | This server is used to register API services and track the health of them for use in the API Mediation Layer. +| API Mediation Layer | gateway | The gateway unifies all the services of Zowe under one proxied server for improved security, management, and high availability. +| API Mediation Layer | caching-service | The caching service is used to share state between different Zowe instances in a high availability topology. +| App Framework | app-server | The App server powers the Zowe Desktop accessible via web browsers. +| App Framework | zss | Z Secure Services (ZSS) provides REST API services for file, dataset, and other z/OS content. Its APIs are used by apps in the Desktop, such as the the File Editor. + + ## Upgrading a component `zwe components install` is only used for installing a component that is not yet installed. diff --git a/versioned_docs/version-v2.17.x/user-guide/install-configure-zos-extensions.md b/versioned_docs/version-v2.17.x/user-guide/install-configure-zos-extensions.md index 48970663ff..e6ff5096c1 100644 --- a/versioned_docs/version-v2.17.x/user-guide/install-configure-zos-extensions.md +++ b/versioned_docs/version-v2.17.x/user-guide/install-configure-zos-extensions.md @@ -34,6 +34,15 @@ More information such as parameters and examples can be found on the [`zwe compo ## Enable and disable component +Each component and extension of Zowe can be enabled or disabled by changing the value of the "enabled" property of their object in the Zowe configuration YAML. +For example, if you wish to enable or disable the API Catalog, it would be accomplished by setting this value in the YAML: + +```yaml +components: + api-catalog: + enabled: true +``` + Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and [`zwe components disable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) commands to help you enable and disable Zowe server component (extension). In order to be compatible with these commands, components must follow [Zowe server component package format standard](../extend/packaging-zos-extensions.md#zowe-server-component-package-format). **Important** these commands will update your `zowe.yaml` configuration file. @@ -42,6 +51,21 @@ Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zw More information such as parameters and examples can be found on the [`zwe components enable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and the [`zwe components disable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) +### Limiting Zowe to specific service groups + +Zowe's server installation contains groups of components that are useful to run together, but often you do not need to enable all parts of Zowe. +You can save system resources by disabling the parts of Zowe that you do not use. + +| Category | Component | Purpose | +|------|------|------| +| API Mediation Layer | api-catalog | Used to view API swagger / openAPI specifications for registered API services of the API Mediation Layer. +| API Mediation Layer | discovery | This server is used to register API services and track the health of them for use in the API Mediation Layer. +| API Mediation Layer | gateway | The gateway unifies all the services of Zowe under one proxied server for improved security, management, and high availability. +| API Mediation Layer | caching-service | The caching service is used to share state between different Zowe instances in a high availability topology. +| App Framework | app-server | The App server powers the Zowe Desktop accessible via web browsers. +| App Framework | zss | Z Secure Services (ZSS) provides REST API services for file, dataset, and other z/OS content. Its APIs are used by apps in the Desktop, such as the the File Editor. + + ## Upgrading a component `zwe components install` is only used for installing a component that is not yet installed. diff --git a/versioned_docs/version-v2.18.x/user-guide/install-configure-zos-extensions.md b/versioned_docs/version-v2.18.x/user-guide/install-configure-zos-extensions.md index 48970663ff..e6ff5096c1 100644 --- a/versioned_docs/version-v2.18.x/user-guide/install-configure-zos-extensions.md +++ b/versioned_docs/version-v2.18.x/user-guide/install-configure-zos-extensions.md @@ -34,6 +34,15 @@ More information such as parameters and examples can be found on the [`zwe compo ## Enable and disable component +Each component and extension of Zowe can be enabled or disabled by changing the value of the "enabled" property of their object in the Zowe configuration YAML. +For example, if you wish to enable or disable the API Catalog, it would be accomplished by setting this value in the YAML: + +```yaml +components: + api-catalog: + enabled: true +``` + Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and [`zwe components disable`](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) commands to help you enable and disable Zowe server component (extension). In order to be compatible with these commands, components must follow [Zowe server component package format standard](../extend/packaging-zos-extensions.md#zowe-server-component-package-format). **Important** these commands will update your `zowe.yaml` configuration file. @@ -42,6 +51,21 @@ Zowe ships [`zwe components enable`](../appendix/zwe_server_command_reference/zw More information such as parameters and examples can be found on the [`zwe components enable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md) and the [`zwe components disable` reference page](../appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md) +### Limiting Zowe to specific service groups + +Zowe's server installation contains groups of components that are useful to run together, but often you do not need to enable all parts of Zowe. +You can save system resources by disabling the parts of Zowe that you do not use. + +| Category | Component | Purpose | +|------|------|------| +| API Mediation Layer | api-catalog | Used to view API swagger / openAPI specifications for registered API services of the API Mediation Layer. +| API Mediation Layer | discovery | This server is used to register API services and track the health of them for use in the API Mediation Layer. +| API Mediation Layer | gateway | The gateway unifies all the services of Zowe under one proxied server for improved security, management, and high availability. +| API Mediation Layer | caching-service | The caching service is used to share state between different Zowe instances in a high availability topology. +| App Framework | app-server | The App server powers the Zowe Desktop accessible via web browsers. +| App Framework | zss | Z Secure Services (ZSS) provides REST API services for file, dataset, and other z/OS content. Its APIs are used by apps in the Desktop, such as the the File Editor. + + ## Upgrading a component `zwe components install` is only used for installing a component that is not yet installed. diff --git a/versioned_sidebars/version-v2.16.x-sidebars.json b/versioned_sidebars/version-v2.16.x-sidebars.json index 2b6d4bacad..cdff456095 100644 --- a/versioned_sidebars/version-v2.16.x-sidebars.json +++ b/versioned_sidebars/version-v2.16.x-sidebars.json @@ -274,17 +274,7 @@ } ] }, - { - "type": "category", - "label": "Starting and stopping Zowe", - "link": { - "type": "doc", - "id": "user-guide/start-zowe-zos" - }, - "items": [ - "user-guide/api-mediation/configuration-api-mediation-standalone" - ] - }, + "user-guide/start-zowe-zos", "user-guide/verify-zowe-runtime-install", { "type": "category", diff --git a/versioned_sidebars/version-v2.17.x-sidebars.json b/versioned_sidebars/version-v2.17.x-sidebars.json index c233b357ef..2996581ea8 100644 --- a/versioned_sidebars/version-v2.17.x-sidebars.json +++ b/versioned_sidebars/version-v2.17.x-sidebars.json @@ -278,17 +278,7 @@ } ] }, - { - "type": "category", - "label": "Starting and stopping Zowe", - "link": { - "type": "doc", - "id": "user-guide/start-zowe-zos" - }, - "items": [ - "user-guide/api-mediation/configuration-api-mediation-standalone" - ] - }, + "user-guide/start-zowe-zos", "user-guide/verify-zowe-runtime-install", { "type": "category", diff --git a/versioned_sidebars/version-v2.18.x-sidebars.json b/versioned_sidebars/version-v2.18.x-sidebars.json index 9dbf4ad3c6..268a0626df 100644 --- a/versioned_sidebars/version-v2.18.x-sidebars.json +++ b/versioned_sidebars/version-v2.18.x-sidebars.json @@ -279,17 +279,7 @@ } ] }, - { - "type": "category", - "label": "Starting and stopping Zowe", - "link": { - "type": "doc", - "id": "user-guide/start-zowe-zos" - }, - "items": [ - "user-guide/api-mediation/configuration-api-mediation-standalone" - ] - }, + "user-guide/start-zowe-zos", "user-guide/verify-zowe-runtime-install", { "type": "category",