AbdelrahmanElawady commented on code in PR #7620: URL: https://github.com/apache/trafficcontrol/pull/7620#discussion_r1260910535
########## blueprints/varnish-support.md: ########## @@ -0,0 +1,117 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +# Add Varnish Cache Support + +## Problem Description + +Currently Traffic Control uses Traffic Server as the underlying cache server. We can expand that by introducing Varnish cache as an option for the cache server used with its great performance, robustness and modularity. + +## Proposed Change + +From a high level point of view, ATS operates based on configuration files that describe in details how it should work and interact with other servers in the cache hierarchy. These configuration files are managed and generated using `t3c` components that utilize Traffic Ops APIs to get profiles and parameters data required for the configuration files. The proposed change is to use the same data fetched from Traffic Ops APIs to generate configuration files for Varnish cache with almost the same functionality. + +Note: the changes should not affect existing components but rather build on them. + +### Traffic Portal Impact + +n/a + +### Traffic Ops Impact + +n/a + +#### REST API Impact + +n/a + +#### Client Impact + +n/a + +#### Data Model / Database Impact + +- A new profile type will be added `VARNISH_PROFILE` but it won't affect the model or other structures in `lib/go-tc` +- `DeliveryService` structs contain fields related to ATS like `remapText`. It will be parsed and translated to Varnish configuration. + +### ORT Impact + +- `go-varnish` package will be developed to handle generating configuration files for Varnish, Hitch, `varnishncsa` and `logrotate`. For detailed description of mapping configuration files from ATS to Varnish refer to [Varnish Support](https://github.com/apache/trafficcontrol/wiki/Varnish-Support) wiki. +- New subcommands will be added to `t3c` including `t3c-varnish-generate` that works similar to `t3c-generate` but instead will depend on `go-varnish` package to generate different configuration files and `t3c-varnish-apply` that handles applying these configuration files, restarting and reloading different services running. Review Comment: Well, for options used in all cache servers it is no problem to just rewrite it. For options that is not used in Varnish (or other cache servers in the future) like `disable-parent-config-comments` or `ats-version` it won't make sense in other cache servers context. The same case also will happen when other options are introduced in Varnish case. I guess we could restructure the documentation and help option to show options per cache server type: ``` ## common options -dir -silent ... ## ats options -ats-version ... ## varnish options ... ``` What do you think? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@trafficcontrol.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
