diff --git a/.github/workflows/add-depr-ticket-to-depr-board.yml b/.github/workflows/add-depr-ticket-to-depr-board.yml deleted file mode 100644 index 250e394..0000000 --- a/.github/workflows/add-depr-ticket-to-depr-board.yml +++ /dev/null @@ -1,19 +0,0 @@ -# Run the workflow that adds new tickets that are either: -# - labelled "DEPR" -# - title starts with "[DEPR]" -# - body starts with "Proposal Date" (this is the first template field) -# to the org-wide DEPR project board - -name: Add newly created DEPR issues to the DEPR project board - -on: - issues: - types: [opened] - -jobs: - routeissue: - uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master - secrets: - GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }} - GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }} - SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }} diff --git a/.github/workflows/add-remove-label-on-comment.yml b/.github/workflows/add-remove-label-on-comment.yml deleted file mode 100644 index 0f369db..0000000 --- a/.github/workflows/add-remove-label-on-comment.yml +++ /dev/null @@ -1,20 +0,0 @@ -# This workflow runs when a comment is made on the ticket -# If the comment starts with "label: " it tries to apply -# the label indicated in rest of comment. -# If the comment starts with "remove label: ", it tries -# to remove the indicated label. -# Note: Labels are allowed to have spaces and this script does -# not parse spaces (as often a space is legitimate), so the command -# "label: really long lots of words label" will apply the -# label "really long lots of words label" - -name: Allows for the adding and removing of labels via comment - -on: - issue_comment: - types: [created] - -jobs: - add_remove_labels: - uses: openedx/.github/.github/workflows/add-remove-label-on-comment.yml@master - diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml deleted file mode 100644 index fec11d6..0000000 --- a/.github/workflows/commitlint.yml +++ /dev/null @@ -1,10 +0,0 @@ -# Run commitlint on the commit messages in a pull request. - -name: Lint Commit Messages - -on: - - pull_request - -jobs: - commitlint: - uses: openedx/.github/.github/workflows/commitlint.yml@master diff --git a/.github/workflows/self-assign-issue.yml b/.github/workflows/self-assign-issue.yml deleted file mode 100644 index 37522fd..0000000 --- a/.github/workflows/self-assign-issue.yml +++ /dev/null @@ -1,12 +0,0 @@ -# This workflow runs when a comment is made on the ticket -# If the comment starts with "assign me" it assigns the author to the -# ticket (case insensitive) - -name: Assign comment author to ticket if they say "assign me" -on: - issue_comment: - types: [created] - -jobs: - self_assign_by_comment: - uses: openedx/.github/.github/workflows/self-assign-issue.yml@master diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 261a82e..0000000 --- a/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -.DS_Store -infra-*/kubeconfig -infra-*/terraform.tfstate -infra-*/terraform.tfstate* -infra-*/.terraform* -infra-*/secrets.auto.tfvars -my-notes -values.yaml diff --git a/LICENSE b/LICENSE deleted file mode 100644 index bae94e1..0000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. \ No newline at end of file diff --git a/catalog-info.yaml b/catalog-info.yaml deleted file mode 100644 index a34dc85..0000000 --- a/catalog-info.yaml +++ /dev/null @@ -1,13 +0,0 @@ -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: 'openedx-k8s-harmony' - description: "A Prototype Helm Chart for deploying multiple Open edX instances (via Tutor) onto a cluster." - links: - - url: "https://github.com/openedx/openedx-k8s-harmony" - title: "Source Code" - icon: "Code" -spec: - owner: group:openedx-k8s-harmony-maintainers - type: 'source-code' - lifecycle: 'experimental' diff --git a/harmony-chart/.helmignore b/harmony-chart/.helmignore deleted file mode 100644 index daea33f..0000000 --- a/harmony-chart/.helmignore +++ /dev/null @@ -1,25 +0,0 @@ -# Patterns to ignore when building packages. -# This supports shell glob matching, relative path matching, and -# negation (prefixed with !). Only one pattern per line. -.DS_Store -# Common VCS dirs -.git/ -.gitignore -.bzr/ -.bzrignore -.hg/ -.hgignore -.svn/ -# Common backup files -*.swp -*.bak -*.tmp -*.orig -*~ -# Various IDEs -.project -.idea/ -*.tmproj -.vscode/ -# Example files -*.yamlX \ No newline at end of file diff --git a/harmony-chart/Chart.lock b/harmony-chart/Chart.lock deleted file mode 100644 index 6614621..0000000 --- a/harmony-chart/Chart.lock +++ /dev/null @@ -1,18 +0,0 @@ -dependencies: -- name: ingress-nginx - repository: https://kubernetes.github.io/ingress-nginx - version: 4.4.2 -- name: cert-manager - repository: https://charts.jetstack.io - version: v1.11.0 -- name: elasticsearch - repository: https://helm.elastic.co - version: 7.17.3 -- name: metrics-server - repository: https://kubernetes-sigs.github.io/metrics-server/ - version: 3.8.4 -- name: vertical-pod-autoscaler - repository: https://cowboysysop.github.io/charts/ - version: 6.0.3 -digest: sha256:4915c21724a8c4693f749aab2c311336990b48e16e90884d7b9ceca42eef69f8 -generated: "2023-04-13T23:07:43.616994532-05:00" diff --git a/harmony-chart/Chart.yaml b/harmony-chart/Chart.yaml deleted file mode 100644 index 165f759..0000000 --- a/harmony-chart/Chart.yaml +++ /dev/null @@ -1,44 +0,0 @@ -apiVersion: v2 -name: harmony-chart -description: A Helm chart for deploying multiple Open edX instances onto Kubernetes using Tutor -type: application -# This is the chart version. This version number should be incremented each time you make changes to the chart and its -# templates, including the app version. -# Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.1.0 -# This is the version number of the application being deployed. This version number should be incremented each time you -# make changes to the application. Versions are not expected to follow Semantic Versioning. They should reflect the -# version the application is using. It is recommended to use it with quotes. -# -# In our case, this represents the version of Tutor that this chart is compatible with. -appVersion: "14.1.1" - -dependencies: -# This is just info for the "helm dependency update" command, which will update the ./charts/ directory when run, using -# this information. -- name: ingress-nginx - version: "4.4.2" - repository: https://kubernetes.github.io/ingress-nginx - condition: ingress-nginx.enabled - -- name: cert-manager - version: "1.11.0" - repository: https://charts.jetstack.io - condition: cert-manager.enabled - -- name: elasticsearch - version: "7.17.3" - condition: elasticsearch.enabled - repository: https://helm.elastic.co - -- name: metrics-server - version: "~3.8.3" - repository: https://kubernetes-sigs.github.io/metrics-server/ - alias: metricsserver - condition: metricsserver.enabled - -- name: vertical-pod-autoscaler - version: "~6.0.3" - repository: https://cowboysysop.github.io/charts/ - alias: vpa - condition: vpa.enabled diff --git a/harmony-chart/charts/cert-manager-v1.11.0.tgz b/harmony-chart/charts/cert-manager-v1.11.0.tgz deleted file mode 100644 index be62968..0000000 Binary files a/harmony-chart/charts/cert-manager-v1.11.0.tgz and /dev/null differ diff --git a/harmony-chart/charts/elasticsearch-7.17.3.tgz b/harmony-chart/charts/elasticsearch-7.17.3.tgz deleted file mode 100644 index 7f7e84f..0000000 Binary files a/harmony-chart/charts/elasticsearch-7.17.3.tgz and /dev/null differ diff --git a/harmony-chart/charts/ingress-nginx-4.4.2.tgz b/harmony-chart/charts/ingress-nginx-4.4.2.tgz deleted file mode 100644 index dd5cfd2..0000000 Binary files a/harmony-chart/charts/ingress-nginx-4.4.2.tgz and /dev/null differ diff --git a/harmony-chart/charts/metrics-server-3.8.4.tgz b/harmony-chart/charts/metrics-server-3.8.4.tgz deleted file mode 100644 index 05a22d2..0000000 Binary files a/harmony-chart/charts/metrics-server-3.8.4.tgz and /dev/null differ diff --git a/harmony-chart/charts/vertical-pod-autoscaler-6.0.3.tgz b/harmony-chart/charts/vertical-pod-autoscaler-6.0.3.tgz deleted file mode 100644 index fa56ecf..0000000 Binary files a/harmony-chart/charts/vertical-pod-autoscaler-6.0.3.tgz and /dev/null differ diff --git a/harmony-chart/templates/NOTES.txt b/harmony-chart/templates/NOTES.txt deleted file mode 100644 index d3eb8c1..0000000 --- a/harmony-chart/templates/NOTES.txt +++ /dev/null @@ -1,42 +0,0 @@ - -Your harmony cluster is now ready to use! - -An NGINX load balancer routes all HTTP/HTTPS traffic into the cluster to each -Open edX instance. Even before you deploy any Open edX instances, you can test -that the load balancer is working. First, get its external IP using - - kubectl get svc -n harmony harmony-ingress-nginx-controller - -Next, go to http://the.external.ip.shown/cluster-echo-test and make sure you get -a JSON response. - - - - - -{{- /* - -Examples of more stuff that can be in a NOTES file: - -{{- if .Values.ingress.enabled }} -{{- range $host := .Values.ingress.hosts }} - {{- range .paths }} - http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} - {{- end }} -{{- end }} -{{- else if contains "NodePort" .Values.service.type }} - export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "harmony-chart.fullname" . }}) - export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") - echo http://$NODE_IP:$NODE_PORT -{{- else if contains "LoadBalancer" .Values.service.type }} - NOTE: It may take a few minutes for the LoadBalancer IP to be available. - You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "harmony-chart.fullname" . }}' - export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "harmony-chart.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") - echo http://$SERVICE_IP:{{ .Values.service.port }} -{{- else if contains "ClusterIP" .Values.service.type }} - export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "harmony-chart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") - echo "Visit http://127.0.0.1:8080 to use your application" - kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT -{{- end }} -*/}} diff --git a/harmony-chart/templates/_helpers.tpl b/harmony-chart/templates/_helpers.tpl deleted file mode 100644 index ea3551a..0000000 --- a/harmony-chart/templates/_helpers.tpl +++ /dev/null @@ -1,62 +0,0 @@ -{{/* -Expand the name of the chart. -*/}} -{{- define "harmony-chart.name" -}} -{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} -{{- end }} - -{{/* -Create a default fully qualified app name. -We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). -If release name contains chart name it will be used as a full name. -*/}} -{{- define "harmony-chart.fullname" -}} -{{- if .Values.fullnameOverride }} -{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} -{{- else }} -{{- $name := default .Chart.Name .Values.nameOverride }} -{{- if contains $name .Release.Name }} -{{- .Release.Name | trunc 63 | trimSuffix "-" }} -{{- else }} -{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} -{{- end }} -{{- end }} -{{- end }} - -{{/* -Create chart name and version as used by the chart label. -*/}} -{{- define "harmony-chart.chart" -}} -{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} -{{- end }} - -{{/* -Common labels -*/}} -{{- define "harmony-chart.labels" -}} -helm.sh/chart: {{ include "harmony-chart.chart" . }} -{{ include "harmony-chart.selectorLabels" . }} -{{- if .Chart.AppVersion }} -app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} -{{- end }} -app.kubernetes.io/managed-by: {{ .Release.Service }} -{{- end }} - -{{/* -Selector labels -*/}} -{{- define "harmony-chart.selectorLabels" -}} -app.kubernetes.io/name: {{ include "harmony-chart.name" . }} -app.kubernetes.io/instance: {{ .Release.Name }} -{{- end }} - -{{/* -Create the name of the service account to use -*/}} -{{- define "harmony-chart.serviceAccountName" -}} -{{- if .Values.serviceAccount.create }} -{{- default (include "harmony-chart.fullname" .) .Values.serviceAccount.name }} -{{- else }} -{{- default "default" .Values.serviceAccount.name }} -{{- end }} -{{- end }} diff --git a/harmony-chart/templates/echo.yaml b/harmony-chart/templates/echo.yaml deleted file mode 100644 index 87f5227..0000000 --- a/harmony-chart/templates/echo.yaml +++ /dev/null @@ -1,58 +0,0 @@ -# This service, which is always enabled, allows you to do basic health checks of your cluster and the Ingress Controller -# Service by accessing /cluster-echo-test via HTTP on any hostname associated with your cluster. -apiVersion: v1 -kind: Service -metadata: - labels: - app: cluster-echo-app - name: cluster-echo-service -spec: - ports: - - port: 8080 - name: high - protocol: TCP - targetPort: 8080 - selector: - app: cluster-echo-app ---- -apiVersion: apps/v1 -kind: Deployment -metadata: - labels: - app: cluster-echo-app - name: cluster-echo-deployment -spec: - replicas: 1 - selector: - matchLabels: - app: cluster-echo-app - strategy: {} - template: - metadata: - creationTimestamp: null - labels: - app: cluster-echo-app - spec: - containers: - - image: mendhak/http-https-echo:25 - name: cluster-echo - ports: - - containerPort: 8080 - resources: {} ---- -apiVersion: networking.k8s.io/v1 -kind: Ingress -metadata: - name: cluster-echo-test -spec: - ingressClassName: {{ (index .Values "ingress-nginx" "controller" "ingressClass") }} - rules: - - http: - paths: - - path: /cluster-echo-test - pathType: Prefix - backend: - service: - name: cluster-echo-service - port: - number: 8080 diff --git a/harmony-chart/templates/elasticsearch/secrets.yaml b/harmony-chart/templates/elasticsearch/secrets.yaml deleted file mode 100644 index e25eecf..0000000 --- a/harmony-chart/templates/elasticsearch/secrets.yaml +++ /dev/null @@ -1,20 +0,0 @@ ---- -{{- $ca := genCA "elasticca" 1825 }} -{{- $cert := genSignedCert "elasticsearch-master.{{ Release.Namespace }}.local" nil (list "elasticsearch-master.{{ Release.Namespace }}.local") 1825 $ca }} -apiVersion: v1 -kind: Secret -metadata: - name: elasticsearch-certificates -type: Opaque -data: - "ca.crt": {{ $ca.Cert | b64enc | toYaml | indent 4}} - "tls.key": {{ $cert.Key | b64enc | toYaml | indent 4}} - "tls.crt": {{ print $cert.Cert $ca.Cert | b64enc | toYaml | indent 4}} ---- -apiVersion: v1 -kind: Secret -metadata: - name: elasticsearch-credentials -type: Opaque -data: - "password": {{ randAlphaNum 32 | b64enc | quote }} diff --git a/harmony-chart/templates/issuer.yaml b/harmony-chart/templates/issuer.yaml deleted file mode 100644 index d3b426b..0000000 --- a/harmony-chart/templates/issuer.yaml +++ /dev/null @@ -1,19 +0,0 @@ -{{ if index .Values "cert-manager" "enabled" }} -apiVersion: cert-manager.io/v1 -kind: ClusterIssuer -metadata: - name: {{ .Release.Name }}-letsencrypt-global -spec: - acme: - {{- if index .Values "cert-manager" "email" }} - email: {{ index .Values "cert-manager" "email" }} - {{- end }} - preferredChain: "" - privateKeySecretRef: - name: {{ .Release.Name }}-letsencrypt-global - server: https://acme-v02.api.letsencrypt.org/directory - solvers: - - http01: - ingress: - class: {{ index .Values "ingress-nginx" "controller" "ingressClass" }} -{{ end }} diff --git a/harmony-chart/templates/tests/example-test-not-used.yamlX b/harmony-chart/templates/tests/example-test-not-used.yamlX deleted file mode 100644 index 34a9779..0000000 --- a/harmony-chart/templates/tests/example-test-not-used.yamlX +++ /dev/null @@ -1,15 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: "{{ include "harmony-chart.fullname" . }}-test-connection" - labels: - {{- include "harmony-chart.labels" . | nindent 4 }} - annotations: - "helm.sh/hook": test -spec: - containers: - - name: wget - image: busybox - command: ['wget'] - args: ['{{ include "harmony-chart.fullname" . }}:{{ .Values.service.port }}'] - restartPolicy: Never diff --git a/harmony-chart/values.yaml b/harmony-chart/values.yaml deleted file mode 100644 index 06d4969..0000000 --- a/harmony-chart/values.yaml +++ /dev/null @@ -1,79 +0,0 @@ -# Default values for tutor-multi-chart. -# This is a YAML-formatted file. -# Declare variables to be passed into your templates. - -ingress-nginx: - # Use ingress-nginx as a default controller. - enabled: true - -cert-manager: - # Use cert-manager as a default certificate controller. - enabled: true - installCRDs: false - # Email address associated with the ACME account. Used to notify about expiring - # certificates. - email: "" - -# Multi-tenant ElasticSearch -elasticsearch: - enabled: false - - # Operators will need to add/update the following setting in each - # of their instances by running the commands: - # ``` - # tutor config save --set K8S_HARMONY_ENABLE_SHARED_ELASTICSEARCH=true --set RUN_ELASTICSEARCH=false - # tutor harmony create-elasticsearch-user - # ``` - # RUN_ELASTICSEARCH: false - # ELASTICSEARCH_PREFIX_INDEX: "username-" - # K8S_HARMONY_USE_SHARED_ELASTICSEARCH: true - # ELASTICSEARCH_AUTH: "username:actual_password" - - # We will create the relevant certs, because they need to shared - # with pods in other namespaces. - createCert: false - # Authentication is only available in https - protocol: https - - # This secret will contain the http certificates. - secretMounts: - - name: elasticsearch-certificates - secretName: elasticsearch-certificates - path: /usr/share/elasticsearch/config/certs - defaultMode: 0777 - - # The password for the elastic user is stored in this secret - extraEnvs: - - name: ELASTIC_PASSWORD - valueFrom: - secretKeyRef: - name: elasticsearch-credentials - key: password - - esConfig: - "elasticsearch.yml": | - xpack.security.enabled: true - xpack.security.http.ssl.enabled: true - xpack.security.http.ssl.key: /usr/share/elasticsearch/config/certs/tls.key - xpack.security.http.ssl.certificate: /usr/share/elasticsearch/config/certs/tls.crt - xpack.security.transport.ssl.enabled: true - xpack.security.transport.ssl.key: /usr/share/elasticsearch/config/certs/tls.key - xpack.security.transport.ssl.certificate: /usr/share/elasticsearch/config/certs/tls.crt - xpack.security.transport.ssl.certificate_authorities: /usr/share/elasticsearch/config/certs/ca.crt - xpack.security.transport.ssl.verification_mode: certificate - -# Configuration for the metrics server chart -metricsserver: - # Control the chart inclusion - enabled: false - # See https://github.com/kubernetes-sigs/metrics-server/blob/master/charts/metrics-server/values.yaml - # for all available options - replicas: 1 -# Configuration for the Vertical Pod Autoscaler chart -vpa: - # Control the chart inclusion - enabled: false - # See https://github.com/cowboysysop/charts/blob/master/charts/vertical-pod-autoscaler/values.yaml - # for all available options - admissionController: - replicaCount: 1 diff --git a/infra-example/k8s-cluster/main.tf b/infra-example/k8s-cluster/main.tf deleted file mode 100644 index 5bd2c5f..0000000 --- a/infra-example/k8s-cluster/main.tf +++ /dev/null @@ -1,55 +0,0 @@ -terraform { - required_providers { - digitalocean = { - source = "digitalocean/digitalocean" - version = ">=2.23" - } - } -} - -variable "cluster_name" { type = string } -variable "do_region" { - type = string - default = "tor1" -} - -data "digitalocean_kubernetes_versions" "available_versions" {} - -resource "digitalocean_kubernetes_cluster" "cluster" { - name = var.cluster_name - region = var.do_region - version = data.digitalocean_kubernetes_versions.available_versions.latest_version - #vpc_uuid = var.vpc_uuid - auto_upgrade = true - # "Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes." - surge_upgrade = true - - node_pool { - name = "${var.cluster_name}-nodes" - size = "s-4vcpu-8gb" - # At this size, at least 3 nodes are recommended to run 2 Open edX instances using the default Tutor images, because - # resources like MySQL/MongoDB are not shared. - min_nodes = 3 - max_nodes = 4 - auto_scale = true - } -} - -resource "local_sensitive_file" "kubeconfig" { - filename = "${path.root}/kubeconfig" - content = digitalocean_kubernetes_cluster.cluster.kube_config[0].raw_config - file_permission = "0400" -} - -output "kubeconfig" { - value = digitalocean_kubernetes_cluster.cluster.kube_config[0] - sensitive = true -} - -output "cluster_urn" { - value = digitalocean_kubernetes_cluster.cluster.urn -} - -output "cluster_id" { - value = digitalocean_kubernetes_cluster.cluster.id -} diff --git a/infra-example/main.tf b/infra-example/main.tf deleted file mode 100644 index 9c119e4..0000000 --- a/infra-example/main.tf +++ /dev/null @@ -1,94 +0,0 @@ -# A cluster to test proof of concept on DigitalOcean -terraform { - required_providers { - digitalocean = { - source = "digitalocean/digitalocean" - version = ">=2.23" - } - kubernetes = { - source = "hashicorp/kubernetes" - version = "2.15.0" - } - kubectl = { - source = "gavinbunney/kubectl" - version = "1.14.0" - } - helm = { - source = "hashicorp/helm" - version = "2.7.1" - } - } -} - -# Configure the DigitalOcean Provider -provider "digitalocean" { - token = var.do_token -} - -variable "cluster_name" { type = string } -variable "do_token" { - type = string - sensitive = true -} - -module "k8s_cluster" { - source = "./k8s-cluster" - - cluster_name = var.cluster_name - # max_worker_node_count = var.max_worker_node_count - # min_worker_node_count = var.min_worker_node_count - # worker_node_size = var.worker_node_size - # region = var.do_region - # vpc_uuid = digitalocean_vpc.main_vpc.id - # vpc_ip_range = var.vpc_ip_range -} - -# Pre-declare data sources that we can use to get the cluster ID and auth info, once it's created -data "digitalocean_kubernetes_cluster" "cluster" { - name = var.cluster_name - # Set the depends_on so that the data source doesn't - # try to read from a cluster that doesn't exist, causing - # failures when trying to run a `terraform plan`. - depends_on = [module.k8s_cluster.cluster_id] -} - -# Configure Kubernetes provider -provider "kubernetes" { - host = data.digitalocean_kubernetes_cluster.cluster.endpoint - token = data.digitalocean_kubernetes_cluster.cluster.kube_config[0].token - cluster_ca_certificate = base64decode(data.digitalocean_kubernetes_cluster.cluster.kube_config[0].cluster_ca_certificate) -} - -# Configure Helm provider -provider "helm" { - kubernetes { - host = data.digitalocean_kubernetes_cluster.cluster.endpoint - token = data.digitalocean_kubernetes_cluster.cluster.kube_config[0].token - cluster_ca_certificate = base64decode(data.digitalocean_kubernetes_cluster.cluster.kube_config[0].cluster_ca_certificate) - } -} - -provider "kubectl" { - host = data.digitalocean_kubernetes_cluster.cluster.endpoint - token = data.digitalocean_kubernetes_cluster.cluster.kube_config[0].token - cluster_ca_certificate = base64decode(data.digitalocean_kubernetes_cluster.cluster.kube_config[0].cluster_ca_certificate) - load_config_file = false -} - - -# Declare the kubeconfig as an output - access it anytime with "terraform output -raw kubeconfig" -output "kubeconfig" { - value = module.k8s_cluster.kubeconfig.raw_config - sensitive = true -} - -resource "digitalocean_project" "project" { - name = var.cluster_name - description = "Testing the use of Helm to provision a cluster for multi-instance tutor deployment" - purpose = "Web Application" - environment = "Production" - - resources = [ - module.k8s_cluster.cluster_urn, - ] -} diff --git a/tutor-contrib-harmony-plugin/.gitignore b/tutor-contrib-harmony-plugin/.gitignore deleted file mode 100644 index b7bcd33..0000000 --- a/tutor-contrib-harmony-plugin/.gitignore +++ /dev/null @@ -1,7 +0,0 @@ -.*.swp -!.gitignore -TODO -__pycache__ -*.egg-info/ -/build/ -/dist/ \ No newline at end of file diff --git a/tutor-contrib-harmony-plugin/MANIFEST.in b/tutor-contrib-harmony-plugin/MANIFEST.in deleted file mode 100644 index 00b80df..0000000 --- a/tutor-contrib-harmony-plugin/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include tutor_k8s_harmony_plugin/patches * -recursive-include tutor_k8s_harmony_plugin/templates * diff --git a/tutor-contrib-harmony-plugin/README.rst b/tutor-contrib-harmony-plugin/README.rst deleted file mode 100644 index d48492f..0000000 --- a/tutor-contrib-harmony-plugin/README.rst +++ /dev/null @@ -1,5 +0,0 @@ -This is a plugin for Tutor to make it easier to deploy multiple Tutor instances -onto a single cluster. This disables the use of Caddy as an external endpoint -and instead uses it only for per-instance routing. An Ingress is used to -automatically register each Open edX instance with a central NGINX load -balancer that routes traffic for the whole cluster. diff --git a/tutor-contrib-harmony-plugin/setup.py b/tutor-contrib-harmony-plugin/setup.py deleted file mode 100644 index 289a860..0000000 --- a/tutor-contrib-harmony-plugin/setup.py +++ /dev/null @@ -1,59 +0,0 @@ -import io -import os -from setuptools import setup, find_packages - -HERE = os.path.abspath(os.path.dirname(__file__)) - - -def load_readme(): - with io.open(os.path.join(HERE, "README.rst"), "rt", encoding="utf8") as f: - return f.read() - - -def load_about(): - about = {} - with io.open( - os.path.join(HERE, "tutor_k8s_harmony_plugin", "__about__.py"), - "rt", - encoding="utf-8", - ) as f: - exec(f.read(), about) # pylint: disable=exec-used - return about - - -ABOUT = load_about() - - -setup( - name="tutor-contrib-harmony-plugin", - version=ABOUT["__version__"], - url="https://github.com/openedx/openedx-k8s-harmony", - project_urls={ - "Code": "https://github.com/openedx/openedx-k8s-harmony", - "Issue tracker": "https://github.com/openedx/openedx-k8s-harmony/issues", - }, - license="AGPLv3", - author="Braden MacDonald", - description="multi instance k8s plugin for Tutor", - long_description=load_readme(), - packages=find_packages(exclude=["tests*"]), - include_package_data=True, - python_requires=">=3.7", - install_requires=["tutor"], - entry_points={ - "tutor.plugin.v1": [ - "k8s_harmony = tutor_k8s_harmony_plugin.plugin" - ] - }, - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "License :: OSI Approved :: GNU Affero General Public License v3", - "Operating System :: OS Independent", - "Programming Language :: Python", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - ], -) diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/__about__.py b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/__about__.py deleted file mode 100644 index a68927d..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/__about__.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.1.0" \ No newline at end of file diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/__init__.py b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/commands.py b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/commands.py deleted file mode 100644 index 643d019..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/commands.py +++ /dev/null @@ -1,44 +0,0 @@ -import os - -import click -from tutor import config as tutor_config -from tutor import env as tutor_env -from tutor.commands.k8s import K8sContext, kubectl_exec -from .elasticsearch import ElasticSearchAPI - -@click.group(help="Commands and subcommands of the openedx-k8s-harmony.") -@click.pass_context -def harmony(context: click.Context) -> None: - context.obj = K8sContext(context.obj.root) - - -@click.command(help="Create or update Elasticsearch users") -@click.pass_obj -def create_elasticsearch_user(context: click.Context): - """ - Creates or updates the Elasticsearch user - """ - config = tutor_config.load(context.root) - namespace = config["K8S_HARMONY_NAMESPACE"] - api = ElasticSearchAPI(namespace) - username, password = config["ELASTICSEARCH_HTTP_AUTH"].split(":", 1) - role_name = f"{username}_role" - - prefix = config["ELASTICSEARCH_INDEX_PREFIX"] - api.post( - f"_security/role/{role_name}", - {"indices": [{"names": [f"{prefix}*"], "privileges": ["all"]}]}, - ) - - api.post( - f"_security/user/{username}", - { - "password": password, - "enabled": True, - "roles": [role_name], - "full_name": username, - }, - ) - - -harmony.add_command(create_elasticsearch_user) diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/elasticsearch.py b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/elasticsearch.py deleted file mode 100644 index c654e31..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/elasticsearch.py +++ /dev/null @@ -1,70 +0,0 @@ -import json -import typing - -from tutor import utils - - -class ElasticSearchAPI: - """ - Helper class to interact with the ElasticSearch - API on the deployed cluster. - """ - - def __init__(self, namespace): - self._command_base = [ - "kubectl", - "exec", - "--stdin", - "--tty", - "--namespace", - namespace, - "elasticsearch-master-0", - "--", - "bash", - "-c", - ] - self._curl_base = ["curl", "--insecure", "-u", "elastic:${ELASTIC_PASSWORD}"] - - def run_command(self, curl_options) -> typing.Union[dict, bytes]: - """ - Invokes a curl command on the first Elasticsearch pod. - - If possible returns the parsed json from the Elasticsearch response. - Otherwise, the raw bytes from the curl command are returned. - """ - response = utils.check_output( - *self._command_base, " ".join(self._curl_base + curl_options) - ) - try: - return json.loads(response) - except (TypeError, ValueError): - return response - - def get(self, endpoint): - """ - Runs a GET request on the Elasticsearch cluster with the specified - endpoint. - - If possible returns the parsed json from the Elasticsearch response. - Otherwise, the raw bytes from the curl command are returned. - """ - return self.run_command(["-XGET", f"https://localhost:9200/{endpoint}"]) - - def post(self, endpoint: str, data: dict) -> typing.Union[dict, bytes]: - """ - Runs a POST request on the Elasticsearch cluster with the specified - endpoint. - - If possible returns the parsed json from the Elasticsearch response. - Otherwise, the raw bytes from the curl command are returned. - """ - return self.run_command( - [ - "-XPOST", - f"https://localhost:9200/{endpoint}", - "-d", - f"'{json.dumps(data)}'", - "-H", - '"Content-Type: application/json"', - ] - ) diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/k8s-services b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/k8s-services deleted file mode 100644 index 626288f..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/k8s-services +++ /dev/null @@ -1,34 +0,0 @@ ---- -# For multi-instance clusters. Allow one central load balancer on the cluster to -# handle HTTPS certs and forward traffic to each Open edX instance's Caddy -# instance. -{%- set HOSTS = [LMS_HOST, CMS_HOST, PREVIEW_HOST, MFE_HOST] + K8S_HARMONY_INGRESS_HOST_LIST %} -apiVersion: networking.k8s.io/v1 -kind: Ingress -metadata: - name: central-lb-to-caddy-ingress - labels: - app.kubernetes.io/component: ingress - annotations: - cert-manager.io/cluster-issuer: harmony-letsencrypt-global -spec: - ingressClassName: {{ K8S_HARMONY_INGRESS_CLASS_NAME }} - rules: - {%- for host in HOSTS if host is defined %} - - host: "{{ host }}" - http: - paths: - - path: / - pathType: Prefix - backend: - service: - name: caddy - port: - number: {{ CADDY_HTTP_PORT }} - {%- endfor %} - tls: - - hosts: - {%- for host in HOSTS if host is defined %} - - {{ host -}} - {% endfor %} - secretName: central-lb-ingress-tls diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/openedx-common-settings b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/openedx-common-settings deleted file mode 100644 index c2e5611..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/openedx-common-settings +++ /dev/null @@ -1,10 +0,0 @@ -{% if K8S_HARMONY_ENABLE_SHARED_ELASTICSEARCH %} -ELASTICSEARCH_INDEX_PREFIX = "{{ELASTICSEARCH_INDEX_PREFIX}}" -ELASTIC_SEARCH_CONFIG = [{ - "use_ssl": True, - "host": "elasticsearch-master.{{K8S_HARMONY_NAMESPACE}}.svc.cluster.local", - "verify_certs": False, - "port": 9200, - "http_auth": "{{ ELASTICSEARCH_HTTP_AUTH }}" -}] -{% endif %} diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/openedx-dockerfile-post-python-requirements b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/openedx-dockerfile-post-python-requirements deleted file mode 100644 index 660080a..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/patches/openedx-dockerfile-post-python-requirements +++ /dev/null @@ -1,7 +0,0 @@ -{% if K8S_HARMONY_ENABLE_SHARED_ELASTICSEARCH %} -# This is needed otherwise the previously installed edx-search -# package doesn't get replaced. Once the below branch is merged -# upstream it will no longer be needed. -RUN pip uninstall -y edx-search -RUN pip install --upgrade git+https://github.com/open-craft/edx-search.git@keith/prefixed-index-names -{% endif %} diff --git a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/plugin.py b/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/plugin.py deleted file mode 100644 index 568f14a..0000000 --- a/tutor-contrib-harmony-plugin/tutor_k8s_harmony_plugin/plugin.py +++ /dev/null @@ -1,57 +0,0 @@ -from glob import glob -import os -import pkg_resources - -from tutor import hooks -from . import commands - -from .__about__ import __version__ - -config = { - "defaults": { - "VERSION": __version__, - # This plugin assumes you are using ingress-nginx as an ingress controller to provide - # you with a central load balancer. The standard Ingress object uses annotations to - # trigger the generation of certificates using cert-manager. - # See: https://cert-manager.io/docs/usage/ingress/#supported-annotations - "INGRESS_CLASS_NAME": "nginx", - # Currently there is no easy way to autodiscover a list of public hosts of your - # Open edX installation to add to your ingress routes. This especially evident - # when installing additional plugins such as tutor-ecommerce or tutor-minio. - # The workaround is to manually add a list of hosts to be routed to the caddy - # instance. - "INGRESS_HOST_LIST": [], - "ENABLE_SHARED_ELASTICSEARCH": False, - }, - "overrides": { - # Don't use Caddy as a per-instance external web proxy, but do still use it - # for per-instance load balancing. - "ENABLE_WEB_PROXY": False, - # We are using HTTPS - "ENABLE_HTTPS": True, - }, - "unique": { - "ELASTICSEARCH_HTTP_AUTH": "{{K8S_NAMESPACE}}:{{ 24|random_string }}", - "ELASTICSEARCH_INDEX_PREFIX": "{{K8S_NAMESPACE}}-{{ 4|random_string|lower }}-", - }, -} - -# Load all configuration entries -hooks.Filters.CONFIG_DEFAULTS.add_items( - [(f"K8S_HARMONY_{key}", value) for key, value in config["defaults"].items()] -) - -hooks.Filters.CONFIG_OVERRIDES.add_items(list(config["overrides"].items())) -hooks.Filters.CONFIG_UNIQUE.add_items(list(config["unique"].items())) - -# Load all patches from the "patches" folder -for path in glob( - os.path.join( - pkg_resources.resource_filename("tutor_k8s_harmony_plugin", "patches"), - "*", - ) -): - with open(path, encoding="utf-8") as patch_file: - hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read())) - -hooks.Filters.CLI_COMMANDS.add_item(commands.harmony) diff --git a/values-example.yaml b/values-example.yaml deleted file mode 100644 index 22eb500..0000000 --- a/values-example.yaml +++ /dev/null @@ -1,15 +0,0 @@ -ingress-nginx: - controller: - config: - proxy-body-size: 100m -cert-manager: - # Set your email address here so auto-generated HTTPS certs will work: - email: "email@example.com" - -elasticsearch: - enabled: false - -metricsserver: - enabled: false -vpa: - enabled: false diff --git a/values-minikube.yaml b/values-minikube.yaml deleted file mode 100644 index 3f12c49..0000000 --- a/values-minikube.yaml +++ /dev/null @@ -1,3 +0,0 @@ -# Disable HTTPS cert provisioning for testing with minikube -cert-manager: - enabled: false