60b309aa1c
Swagger package update |
||
---|---|---|
CachePurgeLibrary | ||
CdnLibrary | ||
CdnPlugins | ||
MultiCdnApi | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
InitialDesign.png | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
SUPPORT.md |
README.md
CachePurge: Cache Invalidation and Purge for multiple CDNs
CachePurge is a centralized service that allows the user to invalidate and purge cache from multiple CDNs easily.
Introduction
CacheOut is implemented in C# using the .NET core framework and uses a combination of Azure Functions, CosmosDB and Azure Queues to create a workflow that begins upon receiving a purge request from the user.
Getting Started
Local Setup
- Refer to this doc for prerequisites: Code and Test Azure functions locally
- Clone this repo to your local drive
- Once your local environment is setup, edit EnvironmentConfig.cs with your config values
Making changes
The project structure is divided into the following:
-
CachePurgeLibrary:
- non-CDN specific code that is utilized throughout the solution
- no changes needed if you're not making significant structural changes to the project
-
CdnLibrary:
- CDN library code used in CdnPlugins and MultiCdnApi
- will need to edit this project heavily to add your own custom CDN specific processing logic
-
CdnPlugins:
- contains CdnPlugin functions and EventCompletion function
- change as needed based on CDNs used
-
MultiCdnApi:
- contains user facing API
- change as needed based on CDNs and user input
To make changes to the CDNs for e.g. to add or remove a CDN, you will need to add your custom CDN logic to CdnLibrary. Propagate the changes down to CdnPlugins and MultiCdnApi.