Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated docs for DS server capability. #7339

Merged
merged 5 commits into from
Feb 8, 2023
Merged

Updated docs for DS server capability. #7339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f28995f
Updated docs for DS server capability.
rimashah25 Feb 2, 2023
81ac5df
Updated based on review comment.
rimashah25 Feb 2, 2023
af66332
Added help tool tip for capability description.
rimashah25 Feb 6, 2023
5f16402
Removed help tool tip for capability description as it doesn't render…
rimashah25 Feb 7, 2023
6c99ce8
Addressed review comments.
rimashah25 Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/source/admin/quick_howto/server_capabililty.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,18 @@ Users with the Operations or Admin :term:`Role` can associate one or more server

.. _delivery_service_required_server_capabilities:

Manage delivery service required server capabilities
====================================================
Users with the Operations or Admin :term:`Role` can associate one or more required server capabilities with a :term:`Delivery Service` by navigating to a :term:`Delivery Service` via :menuselection:`Services --> Delivery Services` and using the context menu for the :term:`Delivery Services` table and selecting :menuselection:`Manage Required Server Capabilities` or by navigating to :menuselection:`Services --> Delivery Services --> Delivery Service --> More --> Manage Required Server Capabilities`.
Configure delivery service required server capabilities
=======================================================
Users with the DELIVERY-SERVICE:CREATE or DELIVERY-SERVICE:UPDATE permission can associate one or more required server capabilities with a :term:`Delivery Service` by navigating to a :term:`Delivery Service` via :menuselection:`Services --> Delivery Services` and clicking on Required Capabilities checkbox present on Delivery Services form (HTTPS and DNS)`.

Adding a required server capability to a :term:`Delivery Service` will ensure two things:

1. Only :term:`Edge-tier caches` with the required capability can be assigned to the :term:`Delivery Service`
2. Only :term:`Mid-tier caches` with the required capability will handle requests of the :term:`Delivery Service` (if applicable)

.. figure:: server_capability/ds_server_caps_table.png
.. figure:: server_capability/ds_required_capability.png
:align: center
:alt: A screenshot of the Traffic Portal UI depicting an example list of Required Server Capabilities for a Delivery Service
:alt: A screenshot of the Traffic Portal UI depicting an example of Required Server Capabilities for a Delivery Service

Example Required Server Capabilities for a Delivery Service Listing

Expand Down
Binary file added docs/source/admin/quick_howto/server_capability/ds_required_capability.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/admin/quick_howto/server_capability/ds_server_caps_table.png
View file
Open in desktop
Binary file not shown.
6 changes: 3 additions & 3 deletions traffic_portal/app/src/common/modules/form/_form.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ button.right-button {
}

/******* tooltip styling *******/
form label.has-tooltip {
form .has-tooltip {
text-decoration: underline dotted;
position: relative;
cursor: help;
Expand Down Expand Up @@ -189,7 +189,7 @@ textarea.autosize:read-only {
}

@media (min-width: 768px) {
form label.has-tooltip {
form .has-tooltip {
div.helptooltip {
left: calc(100% - 140px);
}
Expand All @@ -201,7 +201,7 @@ textarea.autosize:read-only {
}

@media (max-width: 767px) {
form label.has-tooltip {
form .has-tooltip {
div.helptooltip {
left: 0;
}
Expand Down
9 changes: 6 additions & 3 deletions traffic_portal/app/src/common/modules/form/deliveryService/form.deliveryService.DNS.tpl.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,11 +343,14 @@ <h3 ng-if="!open()">Previous Value</h3>
</div>
</div>
<div class="form-group" ng-class="{'has-error': hasError(generalConfig.requiredCapabilities), 'has-feedback': hasError(generalConfig.requiredCapabilities)}">
<label class="has-tooltip control-label col-md-2 col-sm-2 col-xs-12" for="capability">Required Capability
<div class="has-tooltip control-label col-md-2 col-sm-2 col-xs-12">
<label for="capability">Required Capability</label>
<div class="helptooltip">
<div class="helptext">Required capability(ies) associated with a delivery service</div>
<div class="helptext">
Required Server capability(ies) associated with this Delivery Service. <a href="https://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/server_capabililty.html?highlight=Capabilities#configure-delivery-service-required-server-capabilities" target="_blank"> See Required Server Capabilities</a>
</div>
</div>
</label>
</div>
<div class="col-md-10 col-sm-10 col-xs-12">
<div class="checkbox-scroll-container">
<div ng-repeat="capability in requiredCapabilities track by $index">
Expand Down
11 changes: 7 additions & 4 deletions ...fic_portal/app/src/common/modules/form/deliveryService/form.deliveryService.HTTP.tpl.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,11 +343,14 @@ <h3 ng-if="!open()">Previous Value</h3>
</div>
</div>
<div class="form-group" ng-class="{'has-error': hasError(generalConfig.requiredCapabilities), 'has-feedback': hasError(generalConfig.requiredCapabilities)}">
<label class="has-tooltip control-label col-md-2 col-sm-2 col-xs-12" for="capability">Required Capability
<div class="has-tooltip control-label col-md-2 col-sm-2 col-xs-12">
<label for="capability">Required Capability</label>
<div class="helptooltip">
<div class="helptext">Required capability(ies) associated with this Delivery Service</div>
<div class="helptext">
Required Server capability(ies) associated with this Delivery Service. <a href="https://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/server_capabililty.html?highlight=Capabilities#configure-delivery-service-required-server-capabilities" target="_blank"> See Required Server Capabilities</a>
</div>
</div>
</label>
</div>
<div class="col-md-10 col-sm-10 col-xs-12">
<div class="checkbox-scroll-container">
<div ng-repeat="capability in requiredCapabilities track by $index">
Expand All @@ -359,7 +362,7 @@ <h3 ng-if="!open()">Previous Value</h3>
ng-model="selectedCapabilities[capability.name]"
ng-checked="selectedCapabilities[capability.name]"
/>
<a ng-href="/#!/server-capabilities/edit?name={{capability.name}}" target="_blank">{{capability.name}}</a>
<a ng-href="/#!/server-capabilities/edit?name={{capability.name}}" target="_blank">{{capability.name}}</a>
</div>
</div>
<aside class="current-value" ng-if="settings.isRequest" ng-show="deliveryService.requiredCapabilities !== dsCurrent.requiredCapabilities">
Expand Down