├── .github └── workflows │ ├── main.yml │ └── staging.yml ├── .gitignore ├── .gitmodules ├── Dockerfile ├── LICENSE.md ├── README.md ├── archetypes └── default.md ├── config ├── production │ └── config.toml └── staging │ └── config.toml ├── content ├── _assets │ └── images │ │ └── paws-overview.png └── _index.md ├── layouts └── partials │ └── docs │ └── inject │ └── head.html └── resources └── _gen └── assets └── scss ├── book.scss_50fc8c04e12a2f59027287995557ceff.content └── book.scss_50fc8c04e12a2f59027287995557ceff.json /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI for Production 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - name: Checkout repository and submodules 13 | uses: actions/checkout@v2 14 | with: 15 | submodules: recursive 16 | 17 | - name: Build and Push to Humanitec 18 | uses: humanitec/build-push-to-humanitec@v1 19 | with: 20 | humanitec-token: ${{ secrets.HUMANITEC_TOKEN }} 21 | organization: internaldeveloperplatform 22 | additional-docker-arguments: --build-arg env=production 23 | image-name: public-site-caws 24 | -------------------------------------------------------------------------------- /.github/workflows/staging.yml: -------------------------------------------------------------------------------- 1 | name: CI for Staging 2 | 3 | on: 4 | push: 5 | branches: [staging] 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - name: Checkout repository and submodules 13 | uses: actions/checkout@v2 14 | with: 15 | submodules: recursive 16 | 17 | - name: Build and Push to Humanitec 18 | uses: humanitec/build-push-to-humanitec@v1 19 | with: 20 | humanitec-token: ${{ secrets.HUMANITEC_TOKEN }} 21 | organization: internaldeveloperplatform 22 | additional-docker-arguments: --build-arg env=staging 23 | image-name: public-site-caws 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .hugo_build.lock 2 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "themes/hugo-book"] 2 | path = themes/hugo-book 3 | url = https://github.com/alex-shpak/hugo-book 4 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM klakegg/hugo:0.94.2-ext-alpine as build 2 | 3 | ARG env=staging 4 | 5 | COPY ./ /site 6 | WORKDIR /site 7 | RUN hugo --environment $env 8 | 9 | #Copy static files to Nginx 10 | FROM nginx:alpine 11 | COPY --from=build /site/public /usr/share/nginx/html 12 | 13 | WORKDIR /usr/share/nginx/html -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # Creative Commons Attribution-ShareAlike 4.0 International 2 | 3 | Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. 4 | 5 | ### Using Creative Commons Public Licenses 6 | 7 | Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. 8 | 9 | - **Considerations for licensors:** Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). 10 | 11 | - **Considerations for the public:** By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). 12 | 13 | ## Creative Commons Attribution-ShareAlike 4.0 International Public License 14 | 15 | By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. 16 | 17 | ### Section 1 – Definitions. 18 | 19 | a. **Adapted Material** means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. 20 | 21 | b. **Adapter's License** means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. 22 | 23 | c. **BY-SA Compatible License** means a license listed at [creativecommons.org/compatiblelicenses](http://creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License. 24 | 25 | d. **Copyright and Similar Rights** means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. 26 | 27 | e. **Effective Technological Measures** means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. 28 | 29 | f. **Exceptions and Limitations** means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. 30 | 31 | g. **License Elements** means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. 32 | 33 | h. **Licensed Material** means the artistic or literary work, database, or other material to which the Licensor applied this Public License. 34 | 35 | i. **Licensed Rights** means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. 36 | 37 | j. **Licensor** means the individual(s) or entity(ies) granting rights under this Public License. 38 | 39 | k. **Share** means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. 40 | 41 | l. **Sui Generis Database Rights** means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. 42 | 43 | m. **You** means the individual or entity exercising the Licensed Rights under this Public License. **Your** has a corresponding meaning. 44 | 45 | ### Section 2 – Scope. 46 | 47 | a. **_License grant._** 48 | 49 | 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: 50 | 51 | A. reproduce and Share the Licensed Material, in whole or in part; and 52 | 53 | B. produce, reproduce, and Share Adapted Material. 54 | 55 | 2. **Exceptions and Limitations.** For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. 56 | 57 | 3. **Term.** The term of this Public License is specified in Section 6(a). 58 | 59 | 4. **Media and formats; technical modifications allowed.** The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. 60 | 61 | 5. **Downstream recipients.** 62 | 63 | A. **Offer from the Licensor – Licensed Material.** Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. 64 | 65 | B. **Additional offer from the Licensor – Adapted Material.** Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. 66 | 67 | C. **No downstream restrictions.** You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. 68 | 69 | 6. **No endorsement.** Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). 70 | 71 | b. **_Other rights._** 72 | 73 | 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. 74 | 75 | 2. Patent and trademark rights are not licensed under this Public License. 76 | 77 | 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. 78 | 79 | ### Section 3 – License Conditions. 80 | 81 | Your exercise of the Licensed Rights is expressly made subject to the following conditions. 82 | 83 | a. **_Attribution._** 84 | 85 | 1. If You Share the Licensed Material (including in modified form), You must: 86 | 87 | A. retain the following if it is supplied by the Licensor with the Licensed Material: 88 | 89 | i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); 90 | 91 | ii. a copyright notice; 92 | 93 | iii. a notice that refers to this Public License; 94 | 95 | iv. a notice that refers to the disclaimer of warranties; 96 | 97 | v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; 98 | 99 | B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and 100 | 101 | C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. 102 | 103 | 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. 104 | 105 | 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. 106 | 107 | b. **_ShareAlike._** 108 | 109 | In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. 110 | 111 | 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. 112 | 113 | 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. 114 | 115 | 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. 116 | 117 | ### Section 4 – Sui Generis Database Rights. 118 | 119 | Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: 120 | 121 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; 122 | 123 | b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and 124 | 125 | c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. 126 | 127 | For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. 128 | 129 | ### Section 5 – Disclaimer of Warranties and Limitation of Liability. 130 | 131 | a. **Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.** 132 | 133 | b. **To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.** 134 | 135 | c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. 136 | 137 | ### Section 6 – Term and Termination. 138 | 139 | a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. 140 | 141 | b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: 142 | 143 | 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or 144 | 145 | 2. upon express reinstatement by the Licensor. 146 | 147 | For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. 148 | 149 | c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. 150 | 151 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. 152 | 153 | ### Section 7 – Other Terms and Conditions. 154 | 155 | a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. 156 | 157 | b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. 158 | 159 | ### Section 8 – Interpretation. 160 | 161 | a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. 162 | 163 | b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. 164 | 165 | c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. 166 | 167 | d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. 168 | 169 | > Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” The text of the Creative Commons public licenses is dedicated to the public domain under the [CC0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/legalcode). Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. 170 | > 171 | > Creative Commons may be contacted at creativecommons.org. 172 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PAWS - Platform-Agnostic Workload Specification 2 | 3 | This repository holds the source code for the public community page [PAWS - Platform-Agnostic Workload Specification](https://cloudagnosticworkloadspecification.com). We welcome public contributions. Please make sure to follow the instructions below to contribute. You can reach out to us [via email](mailto:info@cloudagnosticworkloadspecification.com) in case of any questions. 4 | 5 | ## How to contribute 6 | 7 | We are using Hugo to generate a static site from the md-files in this repository. In order to contribute, clone this repository and make your changes. Make sure to test your changes locally (see next section) before submitting a pull request. Once you are happy with your contribution, submit a pull request against the `main` branch (or the `staging` branch if your changes are more experimental). 8 | 9 | ## Test the site locally 10 | 11 | Make sure that you have Hugo installed. If not then please follow the instructions [here](https://gohugo.io/getting-started/installing/). Check out the repository and make sure that you also check out the required submodules. 12 | 13 | ``` 14 | git submodule update --init --recursive 15 | ``` 16 | 17 | Then run the following command in the ROOT of the repository. 18 | 19 | ``` 20 | hugo serve --environment staging 21 | ``` 22 | -------------------------------------------------------------------------------- /archetypes/default.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "{{ replace .Name "-" " " | title }}" 3 | date: {{ .Date }} 4 | draft: true 5 | --- 6 | 7 | -------------------------------------------------------------------------------- /config/production/config.toml: -------------------------------------------------------------------------------- 1 | baseURL = 'https://paws.sh/' 2 | title = 'PAWS - Platform-Agnostic Workload Specification' 3 | theme = 'hugo-book' 4 | 5 | # (Optional) Set Google Analytics if you use it to track your website. 6 | # Always put it on the top of the configuration file, otherwise it won't work 7 | # googleAnalytics = "UA-XXXXXXXXX-X" 8 | 9 | # (Optional) If you provide a Disqus shortname, comments will be enabled on 10 | # all pages. 11 | # disqusShortname = "my-site" 12 | 13 | # (Optional) Set this to true if you use capital letters in file names 14 | disablePathToLower = true 15 | 16 | # (Optional) Set this to true to enable 'Last Modified by' date and git author 17 | # information on 'doc' type pages. 18 | enableGitInfo = true 19 | 20 | # (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy. 21 | # You can remove related files with config below 22 | disableKinds = ['taxonomy', 'taxonomyTerm'] 23 | 24 | # Needed for mermaid/katex shortcodes 25 | [markup] 26 | [markup.goldmark.renderer] 27 | unsafe = true 28 | 29 | [markup.tableOfContents] 30 | startLevel = 2 31 | 32 | # Multi-lingual mode config 33 | # There are different options to translate files 34 | # See https://gohugo.io/content-management/multilingual/#translation-by-filename 35 | # And https://gohugo.io/content-management/multilingual/#translation-by-content-directory 36 | [languages] 37 | [languages.en] 38 | languageName = 'English' 39 | contentDir = 'content' 40 | weight = 1 41 | 42 | [menu] 43 | # [[menu.before]] 44 | [[menu.after]] 45 | name = "Github" 46 | url = "https://github.com/cloudagnosticworkloadspecification/public-site" 47 | weight = 10 48 | 49 | [[menu.after]] 50 | name = "Contact" 51 | url = "mailto:info@paws.sh" 52 | weight = 20 53 | 54 | [params] 55 | # (Optional, default light) Sets color theme: light, dark or auto. 56 | # Theme 'auto' switches between dark and light modes based on browser/os preferences 57 | BookTheme = 'light' 58 | 59 | # (Optional, default true) Controls table of contents visibility on right side of pages. 60 | # Start and end levels can be controlled with markup.tableOfContents setting. 61 | # You can also specify this parameter per page in front matter. 62 | BookToC = true 63 | 64 | # (Optional, default none) Set the path to a logo for the book. If the logo is 65 | # /static/logo.png then the path would be logo.png 66 | # BookLogo = 'logo.png' 67 | 68 | # (Optional, default none) Set leaf bundle to render as side menu 69 | # When not specified file structure and weights will be used 70 | # BookMenuBundle = '/menu' 71 | 72 | # (Optional, default docs) Specify root page to render child pages as menu. 73 | # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/ 74 | # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/' 75 | BookSection = '*' 76 | 77 | # Set source repository location. 78 | # Used for 'Last Modified' and 'Edit this page' links. 79 | BookRepo = 'https://github.com/cloudagnosticworkloadspecification/public-site' 80 | 81 | # Enable "Edit this page" links for 'doc' page type. 82 | # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. 83 | # Edit path must point to root directory of repo. 84 | # BookEditPath = 'edit/master/public-site' 85 | 86 | # Configure the date format used on the pages 87 | # - In git information 88 | # - In blog posts 89 | BookDateFormat = 'January 2, 2006' 90 | 91 | # (Optional, default true) Enables search function with flexsearch, 92 | # Index is built on fly, therefore it might slowdown your website. 93 | # Configuration for indexing can be adjusted in i18n folder per language. 94 | BookSearch = true 95 | 96 | # (Optional, default true) Enables comments template on pages 97 | # By default partals/docs/comments.html includes Disqus template 98 | # See https://gohugo.io/content-management/comments/#configure-disqus 99 | # Can be overwritten by same param in page frontmatter 100 | BookComments = false 101 | 102 | # /!\ This is an experimental feature, might be removed or changed at any time 103 | # (Optional, experimental, default false) Enables portable links and link checks in markdown pages. 104 | # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode 105 | # Theme will print warning if page referenced in markdown does not exists. 106 | BookPortableLinks = true 107 | 108 | # /!\ This is an experimental feature, might be removed or changed at any time 109 | # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use. 110 | BookServiceWorker = true 111 | 112 | # /!\ This is an experimental feature, might be removed or changed at any time 113 | # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present. 114 | BookTranslatedOnly = true 115 | 116 | # Google Tag Manager 117 | # googleTagManagerId = "GTM-M4F8PQZ" 118 | 119 | # Add image for Open Graph 120 | # images = ["full_logo.png"] 121 | 122 | # Set to true if you want to set all pages to noindex 123 | noindex = true -------------------------------------------------------------------------------- /config/staging/config.toml: -------------------------------------------------------------------------------- 1 | baseURL = 'https://howehuelsoconnellwindlerwatsica.newapp.io/' 2 | title = 'PAWS - Platform-Agnostic Workload Specification' 3 | theme = 'hugo-book' 4 | 5 | # (Optional) Set Google Analytics if you use it to track your website. 6 | # Always put it on the top of the configuration file, otherwise it won't work 7 | # googleAnalytics = "UA-XXXXXXXXX-X" 8 | 9 | # (Optional) If you provide a Disqus shortname, comments will be enabled on 10 | # all pages. 11 | # disqusShortname = "my-site" 12 | 13 | # (Optional) Set this to true if you use capital letters in file names 14 | disablePathToLower = true 15 | 16 | # (Optional) Set this to true to enable 'Last Modified by' date and git author 17 | # information on 'doc' type pages. 18 | # enableGitInfo = true 19 | 20 | # (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy. 21 | # You can remove related files with config below 22 | disableKinds = ['taxonomy', 'taxonomyTerm'] 23 | 24 | # Needed for mermaid/katex shortcodes 25 | [markup] 26 | [markup.goldmark.renderer] 27 | unsafe = true 28 | 29 | [markup.tableOfContents] 30 | startLevel = 2 31 | 32 | # Multi-lingual mode config 33 | # There are different options to translate files 34 | # See https://gohugo.io/content-management/multilingual/#translation-by-filename 35 | # And https://gohugo.io/content-management/multilingual/#translation-by-content-directory 36 | [languages] 37 | [languages.en] 38 | languageName = 'English' 39 | contentDir = 'content' 40 | weight = 1 41 | 42 | [menu] 43 | # [[menu.before]] 44 | [[menu.after]] 45 | name = "Github" 46 | url = "https://github.com/cloudagnosticworkloadspecification/public-site" 47 | weight = 10 48 | 49 | [[menu.after]] 50 | name = "Contact" 51 | url = "mailto:info@caws.sh" 52 | weight = 20 53 | 54 | [params] 55 | # (Optional, default light) Sets color theme: light, dark or auto. 56 | # Theme 'auto' switches between dark and light modes based on browser/os preferences 57 | BookTheme = 'light' 58 | 59 | # (Optional, default true) Controls table of contents visibility on right side of pages. 60 | # Start and end levels can be controlled with markup.tableOfContents setting. 61 | # You can also specify this parameter per page in front matter. 62 | BookToC = true 63 | 64 | # (Optional, default none) Set the path to a logo for the book. If the logo is 65 | # /static/logo.png then the path would be logo.png 66 | # BookLogo = 'logo.png' 67 | 68 | # (Optional, default none) Set leaf bundle to render as side menu 69 | # When not specified file structure and weights will be used 70 | # BookMenuBundle = '/menu' 71 | 72 | # (Optional, default docs) Specify root page to render child pages as menu. 73 | # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/ 74 | # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/' 75 | BookSection = '*' 76 | 77 | # Set source repository location. 78 | # Used for 'Last Modified' and 'Edit this page' links. 79 | BookRepo = 'https://github.com/cloudagnosticworkloadspecification/public-site' 80 | 81 | # Enable "Edit this page" links for 'doc' page type. 82 | # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. 83 | # Edit path must point to root directory of repo. 84 | # BookEditPath = 'edit/master/public-site' 85 | 86 | # Configure the date format used on the pages 87 | # - In git information 88 | # - In blog posts 89 | BookDateFormat = 'January 2, 2006' 90 | 91 | # (Optional, default true) Enables search function with flexsearch, 92 | # Index is built on fly, therefore it might slowdown your website. 93 | # Configuration for indexing can be adjusted in i18n folder per language. 94 | BookSearch = true 95 | 96 | # (Optional, default true) Enables comments template on pages 97 | # By default partals/docs/comments.html includes Disqus template 98 | # See https://gohugo.io/content-management/comments/#configure-disqus 99 | # Can be overwritten by same param in page frontmatter 100 | BookComments = false 101 | 102 | # /!\ This is an experimental feature, might be removed or changed at any time 103 | # (Optional, experimental, default false) Enables portable links and link checks in markdown pages. 104 | # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode 105 | # Theme will print warning if page referenced in markdown does not exists. 106 | BookPortableLinks = true 107 | 108 | # /!\ This is an experimental feature, might be removed or changed at any time 109 | # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use. 110 | BookServiceWorker = true 111 | 112 | # /!\ This is an experimental feature, might be removed or changed at any time 113 | # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present. 114 | BookTranslatedOnly = true 115 | 116 | # Add image for Open Graph 117 | # images = ["full_logo.png"] 118 | 119 | # Set to true if you want to set all pages to noindex 120 | noindex = true -------------------------------------------------------------------------------- /content/_assets/images/paws-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/platformagnosticworkloadspecification/public-site/49cf4c299bca602e6fee8b383383d90d5c29e30c/content/_assets/images/paws-overview.png -------------------------------------------------------------------------------- /content/_index.md: -------------------------------------------------------------------------------- 1 | +++ 2 | title="PAWS - Platform-Agnostic Workload Specification" 3 | weight=0 4 | +++ 5 | 6 | # PAWS - Platform-Agnostic Workload Specification 7 | 8 | ## What is “PAWS”? 9 | 10 | {{< hint info >}} 11 | PAWS _is currently in alpha if you’re interested to join and provide feedback go [here.](https://forms.gle/z4MHQvdp4hYjv6eHA)_ 12 | {{< /hint >}} 13 | 14 | PAWS is a specification for defining environment agnostic configuration for cloud based workloads. The PAWS configuration itself is saved alongside the code of the workload in source control. This configuration can then be combined with environment specific parameters to run the workload in the target environment. The same workload can then be run on completely different technology stacks without the developer needing to be an expert in any one of them. 15 | 16 | For example, the same PAWS configuration can be used to generate a docker-compose file for local development, Kubernetes manifests for deployment to a shared development environment and to a serverless platform such as Google Cloud Run for integration tests. 17 | 18 | ## Why PAWS? 19 | 20 | Cloud-native developers often struggle with config drift between environments. This is made even more complicated when the technology stack in each environment is different. Maybe you use Docker Compose for local development but Helm Charts to deploy to the Kubernetes based development environment? Not only do you have to figure out Docker Compose and Helm, but you need to keep them in sync! 21 | 22 | PAWS is a single, easy to understand configuration for each workload. This configuration can then be used to generate the docker compose file or Kubernetes manifests that you need to get the workload up and running. 23 | 24 | ## How it works 25 | 26 | PAWS is expressed in YAML and sits alongside the code for the workload in source control. It describes the environment agnostic configuration needed to run the workload. This can include: 27 | 28 | - Templated configuration in the form of Environment Variables or Files 29 | - Dependencies on resources such as Databases, Volumes or DNS names 30 | - Dependencies on other workloads and services 31 | - Routes that the workload should respond to 32 | - Container overrides such as for CMD and ARGS 33 | 34 | A tool known as a PAWS Implementation is then run against the PAWS configuration. It is up to the implementation how it deals with environment specific parameters. The result of the Implementation is either to deploy the workload in some environment (e.g. deploying to a K8s cluster or Google Cloud Run) or output files which can be used to run the workload in an environment e.g. a `docker-compose.yaml` file for local development or Kubernetes manifests for a K8s deployment) 35 | 36 | ### Example 37 | 38 | Consider a product catalogue service that manages products. It’s API is available under the `/products` and it stores its products in a PostgreSQL database. 39 | 40 | The PAWS configuration might look as follows: 41 | 42 | ```bash 43 | apiVersion: spec.paws.sh/v1alpha1 44 | kind: Workload 45 | metadata: 46 | name: products-catalog 47 | spec: 48 | resources: 49 | db: 50 | type: postgres 51 | api-dns: 52 | type: dns 53 | container: 54 | variables: 55 | CONNECTION_STRING: postgresql://${resources.db.user}:${resources.db.password}@${resources.db.host}:${resources.db.port}/${resources.db.name} 56 | routes: 57 | resources.api-dns.host: 58 | /products: 59 | match: prefix 60 | ``` 61 | 62 | For the local environment, the docker-compose PAWS implementation might be used. This might produce the following docker-compose file: 63 | 64 | ```bash 65 | products-catalog: 66 | build: . 67 | 68 | depends_on: 69 | - products-catalog--db 70 | 71 | environment: 72 | CONNECTION_STRING: postgresql://postgres:p455w0rd@products-catalog--db:5432/postgres 73 | 74 | products-catalog--db: 75 | image: postgres:14 76 | environment: 77 | POSTGRES_PASSWORD: p455w0rd 78 | ``` 79 | 80 | While for the K8s implementation might create Kubernetes Deployment, Service, Ingress, ConfigMap and Secret manifests. 81 | 82 | {{< figure link="/_assets/images/paws-overview.png" src="/_assets/images/paws-overview.png" caption="PAWS Configuration and Implementation" alt="paws-overview.png" >}} 83 | 84 | ## Development Status 85 | 86 | PAWS is currently in alpha. PAWS is developed by an open consortium around Lee Ditiangkin, Guy Sayer, Chris Stephenson, Kaspar von Grünberg, and many others. 87 | -------------------------------------------------------------------------------- /layouts/partials/docs/inject/head.html: -------------------------------------------------------------------------------- 1 | {{ if .Site.Params.noindex }} 2 | 3 | {{ end }} 4 | -------------------------------------------------------------------------------- /resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.content: -------------------------------------------------------------------------------- 1 | @charset "UTF-8";:root{--gray-100:#f8f9fa;--gray-200:#e9ecef;--gray-500:#adb5bd;--color-link:#0055bb;--color-visited-link:#8440f1;--body-background:white;--body-font-color:black;--icon-filter:none;--hint-color-info:#6bf;--hint-color-warning:#fd6;--hint-color-danger:#f66}/*!normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css*/html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}button,[type=button],[type=reset],[type=submit]{-webkit-appearance:button}button::-moz-focus-inner,[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner{border-style:none;padding:0}button:-moz-focusring,[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none}.flex{display:flex}.flex-auto{flex:auto}.flex-even{flex:1 1}.flex-wrap{flex-wrap:wrap}.justify-start{justify-content:flex-start}.justify-end{justify-content:flex-end}.justify-center{justify-content:center}.justify-between{justify-content:space-between}.align-center{align-items:center}.mx-auto{margin:0 auto}.text-center{text-align:center}.text-left{text-align:left}.text-right{text-align:right}.hidden{display:none}input.toggle{height:0;width:0;overflow:hidden;opacity:0;position:absolute}.clearfix::after{content:"";display:table;clear:both}html{font-size:16px;scroll-behavior:smooth;touch-action:manipulation}body{min-width:20rem;color:var(--body-font-color);background:var(--body-background);letter-spacing:.33px;font-weight:400;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;box-sizing:border-box}body *{box-sizing:inherit}h1,h2,h3,h4,h5{font-weight:400}a{text-decoration:none;color:var(--color-link)}img{vertical-align:baseline}:focus{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}aside nav ul{padding:0;margin:0;list-style:none}aside nav ul li{margin:1em 0;position:relative}aside nav ul a{display:block}aside nav ul a:hover{opacity:.5}aside nav ul ul{padding-inline-start:1rem}ul.pagination{display:flex;justify-content:center;list-style-type:none}ul.pagination .page-item a{padding:1rem}.container{max-width:80rem;margin:0 auto}.book-icon{filter:var(--icon-filter)}.book-brand{margin-top:0;margin-bottom:1rem}.book-brand img{height:1.5em;width:1.5em;margin-inline-end:.5rem}.book-menu{flex:0 0 16rem;font-size:.875rem}.book-menu .book-menu-content{width:16rem;padding:1rem;background:var(--body-background);position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-menu a,.book-menu label{color:inherit;cursor:pointer;word-wrap:break-word}.book-menu a.active{color:var(--color-link)}.book-menu input.toggle+label+ul{display:none}.book-menu input.toggle:checked+label+ul{display:block}.book-menu input.toggle+label::after{content:"▸"}.book-menu input.toggle:checked+label::after{content:"▾"}body[dir=rtl] .book-menu input.toggle+label::after{content:"◂"}body[dir=rtl] .book-menu input.toggle:checked+label::after{content:"▾"}.book-section-flat{margin:2rem 0}.book-section-flat>a,.book-section-flat>span,.book-section-flat>label{font-weight:bolder}.book-section-flat>ul{padding-inline-start:0}.book-page{min-width:20rem;flex-grow:1;padding:1rem}.book-post{margin-bottom:3rem}.book-header{display:none;margin-bottom:1rem}.book-header label{line-height:0}.book-header img.book-icon{height:1.5em;width:1.5em}.book-search{position:relative;margin:1rem 0;border-bottom:1px solid transparent}.book-search input{width:100%;padding:.5rem;border:0;border-radius:.25rem;background:var(--gray-100);color:var(--body-font-color)}.book-search input:required+.book-search-spinner{display:block}.book-search .book-search-spinner{position:absolute;top:0;margin:.5rem;margin-inline-start:calc(100% - 1.5rem);width:1rem;height:1rem;border:1px solid transparent;border-top-color:var(--body-font-color);border-radius:50%;animation:spin 1s ease infinite}@keyframes spin{100%{transform:rotate(360deg)}}.book-search small{opacity:.5}.book-toc{flex:0 0 16rem;font-size:.75rem}.book-toc .book-toc-content{width:16rem;padding:1rem;position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-toc img{height:1em;width:1em}.book-toc nav>ul>li:first-child{margin-top:0}.book-footer{padding-top:1rem;font-size:.875rem}.book-footer img{height:1em;width:1em;margin-inline-end:.5rem}.book-comments{margin-top:1rem}.book-languages{margin-block-end:2rem}.book-languages .book-icon{height:1em;width:1em;margin-inline-end:.5em}.book-languages ul{padding-inline-start:1.5em}.book-menu-content,.book-toc-content,.book-page,.book-header aside,.markdown{transition:.2s ease-in-out;transition-property:transform,margin,opacity,visibility;will-change:transform,margin,opacity}@media screen and (max-width:56rem){#menu-control,#toc-control{display:inline}.book-menu{visibility:hidden;margin-inline-start:-16rem;font-size:16px;z-index:1}.book-toc{display:none}.book-header{display:block}#menu-control:focus~main label[for=menu-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#menu-control:checked~main .book-menu{visibility:initial}#menu-control:checked~main .book-menu .book-menu-content{transform:translateX(16rem);box-shadow:0 0 .5rem rgba(0,0,0,.1)}#menu-control:checked~main .book-page{opacity:.25}#menu-control:checked~main .book-menu-overlay{display:block;position:absolute;top:0;bottom:0;left:0;right:0}#toc-control:focus~main label[for=toc-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#toc-control:checked~main .book-header aside{display:block}body[dir=rtl] #menu-control:checked~main .book-menu .book-menu-content{transform:translateX(-16rem)}}@media screen and (min-width:80rem){.book-page,.book-menu .book-menu-content,.book-toc .book-toc-content{padding:2rem 1rem}}@font-face{font-family:roboto;font-style:normal;font-weight:400;font-display:swap;src:local(""),url(fonts/roboto-v27-latin-regular.woff2)format("woff2"),url(fonts/roboto-v27-latin-regular.woff)format("woff")}@font-face{font-family:roboto;font-style:normal;font-weight:700;font-display:swap;src:local(""),url(fonts/roboto-v27-latin-700.woff2)format("woff2"),url(fonts/roboto-v27-latin-700.woff)format("woff")}@font-face{font-family:roboto mono;font-style:normal;font-weight:400;font-display:swap;src:local(""),url(fonts/roboto-mono-v13-latin-regular.woff2)format("woff2"),url(fonts/roboto-mono-v13-latin-regular.woff)format("woff")}body{font-family:roboto,sans-serif}code{font-family:roboto mono,monospace}@media print{.book-menu,.book-footer,.book-toc{display:none}.book-header,.book-header aside{display:block}main{display:block!important}}.markdown{line-height:1.6}.markdown>:first-child{margin-top:0}.markdown h1,.markdown h2,.markdown h3,.markdown h4,.markdown h5,.markdown h6{font-weight:400;line-height:1;margin-top:1.5em;margin-bottom:1rem}.markdown h1 a.anchor,.markdown h2 a.anchor,.markdown h3 a.anchor,.markdown h4 a.anchor,.markdown h5 a.anchor,.markdown h6 a.anchor{opacity:0;font-size:.75em;vertical-align:middle;text-decoration:none}.markdown h1:hover a.anchor,.markdown h1 a.anchor:focus,.markdown h2:hover a.anchor,.markdown h2 a.anchor:focus,.markdown h3:hover a.anchor,.markdown h3 a.anchor:focus,.markdown h4:hover a.anchor,.markdown h4 a.anchor:focus,.markdown h5:hover a.anchor,.markdown h5 a.anchor:focus,.markdown h6:hover a.anchor,.markdown h6 a.anchor:focus{opacity:initial}.markdown h4,.markdown h5,.markdown h6{font-weight:bolder}.markdown h5{font-size:.875em}.markdown h6{font-size:.75em}.markdown b,.markdown optgroup,.markdown strong{font-weight:bolder}.markdown a{text-decoration:none}.markdown a:hover{text-decoration:underline}.markdown a:visited{color:var(--color-visited-link)}.markdown img{max-width:100%;height:auto}.markdown code{padding:0 .25rem;background:var(--gray-200);border-radius:.25rem;font-size:.875em}.markdown pre{padding:1rem;background:var(--gray-100);border-radius:.25rem;overflow-x:auto}.markdown pre code{padding:0;background:0 0}.markdown p{word-wrap:break-word}.markdown blockquote{margin:1rem 0;padding:.5rem 1rem .5rem .75rem;border-inline-start:.25rem solid var(--gray-200);border-radius:.25rem}.markdown blockquote :first-child{margin-top:0}.markdown blockquote :last-child{margin-bottom:0}.markdown table{overflow:auto;display:block;border-spacing:0;border-collapse:collapse;margin-top:1rem;margin-bottom:1rem}.markdown table tr th,.markdown table tr td{padding:.5rem 1rem;border:1px solid var(--gray-200)}.markdown table tr:nth-child(2n){background:var(--gray-100)}.markdown hr{height:1px;border:none;background:var(--gray-200)}.markdown ul,.markdown ol{padding-inline-start:2rem}.markdown dl dt{font-weight:bolder;margin-top:1rem}.markdown dl dd{margin-inline-start:0;margin-bottom:1rem}.markdown .highlight table tr td:nth-child(1) pre{margin:0;padding-inline-end:0}.markdown .highlight table tr td:nth-child(2) pre{margin:0;padding-inline-start:0}.markdown details{padding:1rem;border:1px solid var(--gray-200);border-radius:.25rem}.markdown details summary{line-height:1;padding:1rem;margin:-1rem;cursor:pointer}.markdown details[open] summary{margin-bottom:0}.markdown figure{margin:1rem 0}.markdown figure figcaption p{margin-top:0}.markdown-inner>:first-child{margin-top:0}.markdown-inner>:last-child{margin-bottom:0}.markdown .book-expand{margin-top:1rem;margin-bottom:1rem;border:1px solid var(--gray-200);border-radius:.25rem;overflow:hidden}.markdown .book-expand .book-expand-head{background:var(--gray-100);padding:.5rem 1rem;cursor:pointer}.markdown .book-expand .book-expand-content{display:none;padding:1rem}.markdown .book-expand input[type=checkbox]:checked+.book-expand-content{display:block}.markdown .book-tabs{margin-top:1rem;margin-bottom:1rem;border:1px solid var(--gray-200);border-radius:.25rem;overflow:hidden;display:flex;flex-wrap:wrap}.markdown .book-tabs label{display:inline-block;padding:.5rem 1rem;border-bottom:1px transparent;cursor:pointer}.markdown .book-tabs .book-tabs-content{order:999;width:100%;border-top:1px solid var(--gray-100);padding:1rem;display:none}.markdown .book-tabs input[type=radio]:checked+label{border-bottom:1px solid var(--color-link)}.markdown .book-tabs input[type=radio]:checked+label+.book-tabs-content{display:block}.markdown .book-tabs input[type=radio]:focus+label{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}.markdown .book-columns{margin-left:-1rem;margin-right:-1rem}.markdown .book-columns>div{margin:1rem 0;min-width:10rem;padding:0 1rem}.markdown a.book-btn{display:inline-block;font-size:.875rem;color:var(--color-link);line-height:2rem;padding:0 1rem;border:1px solid var(--color-link);border-radius:.25rem;cursor:pointer}.markdown a.book-btn:hover{text-decoration:none}.markdown .book-hint.info{border-color:#6bf;background-color:rgba(102,187,255,.1)}.markdown .book-hint.warning{border-color:#fd6;background-color:rgba(255,221,102,.1)}.markdown .book-hint.danger{border-color:#f66;background-color:rgba(255,102,102,.1)} -------------------------------------------------------------------------------- /resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.json: -------------------------------------------------------------------------------- 1 | {"Target":"book.min.82c5dbd23447cee0b4c2aa3ed08ce0961faa40e1fa370eee4f8c9f02e0d46b5f.css","MediaType":"text/css","Data":{"Integrity":"sha256-gsXb0jRHzuC0wqo+0Izglh+qQOH6Nw7uT4yfAuDUa18="}} --------------------------------------------------------------------------------