1
1
Configuration Management
2
2
########################
3
3
4
- This repository is a collection of tools and scripts that edx.org uses to deploy
4
+ DEPRECATION WARNING
5
+ *******************
6
+
7
+ This repository is Deprecated and is planned to be archived after the Redwood
8
+ Cut (Late April 2024). See https://github.com/openedx/public-engineering/issues/51
9
+ for more details and up-to-date information.
10
+
11
+ Description
12
+ ***********
13
+
14
+ This repository is a collection of tools and scripts that edx.org uses to deploy
5
15
openedx. The purpose of this repository is to share portions of our toolchain
6
- with the community. This repository is *not * the best way to get started running
16
+ with the community. This repository is *not * the best way to get started running
7
17
openedx. For that, please look at `Open EdX Installation options `_, which contains
8
18
links to the recommended paths for new installations.
9
19
@@ -28,7 +38,7 @@ What is in this Repo?
28
38
be used to configure individual services in the openedx platform. See
29
39
`Open EdX Installation options `_ before trying to use any of the scripts in
30
40
this directory.
31
- * `docker </docker >`__: This directory contains dockerfiles that can be used to
41
+ * `docker </docker >`__: This directory contains dockerfiles that can be used to
32
42
test that playbooks execute cleanly. See `Makefiles <Makefiles.rst >`__ for
33
43
Documentation on how to run these containers.
34
44
* `requirements </requirements >`__ : inputs for `pip-compile <https://github.com/jazzband/pip-tools >`__
@@ -44,13 +54,13 @@ Roadmap
44
54
*******
45
55
46
56
This repository is in ``sustained `` status. The goal is to deprecate this codebase
47
- and move the deployment code into the repos with the application code.
57
+ and move the deployment code into the repos with the application code.
48
58
49
- With the adoption of containerized application platforms like `Kubernetes
50
- <https://kubernetes.io/> `__, the tools in this repository are complex
59
+ With the adoption of containerized application platforms like `Kubernetes
60
+ <https://kubernetes.io/> `__, the tools in this repository are complex
51
61
and inappropriate for building small single purpose containers.
52
62
53
- At edx.org, we are focusing on deployment of applications using `Terraform
63
+ At edx.org, we are focusing on deployment of applications using `Terraform
54
64
<https://www.terraform.io/> `__ and `Kubernetes <https://kubernetes.io/ >`__. We
55
65
hope to provide open source tooling for this soon.
56
66
@@ -59,7 +69,7 @@ Contributing
59
69
************
60
70
61
71
* Bugfixes: If you would like to contribute a bugfix to this codebase, please open
62
- a pull request. A bot will automatically walk your contribution through the
72
+ a pull request. A bot will automatically walk your contribution through the
63
73
`Open Source Contribution process <https://edx-developer-guide.readthedocs.io/en/latest/process/overview.html >`__.
64
74
65
75
0 commit comments