Bszabo/tnl 10899 #228
Bszabo/tnl 10899 #228
Conversation
Three endpoints for file asset uploads, video asset uploads, and XBlock CRUD operations
Track script invocations as an audit trail for API gateway configuration changes SRE instructions for deploying changes in this PR to stage and prod environments
base domain is not parameterized, but target API Gateway stage is
|
I see the failed commit test and will attend to it late today or tomorrow |
| --registrar-host stage-edx-registrar.edx.org \ | ||
| --catalog-host catalog.stage.edx.org \ | ||
| --enterprise-catalog-host enterprise-catalog.stage.edx.org \ | ||
| --studio-host courses.stage.edx.org |
There was a problem hiding this comment.
Do you think it would be better if these variable were read from configuration objects / files that can be updated via PR in the repo, instead of always updating the values in these deploy commands directly?
There was a problem hiding this comment.
Not certain if that was a good suggestion by me.
There was a problem hiding this comment.
I'm uncertain what sort of reception this proposal will get from the SRE team. I'll leave anything more than trivial changes for the future, when it's become clear this repo will endure som
Commented out legacy Swagger code as part of binary search to determine which part of YAML file is generating CI test errors
Looking to get past build errors
swagger codegen 2.4.32
Trying to get past build errors
This reverts commit fda3655.
This reverts commit bf679ee.
This reverts commit f89196b.
This reverts commit 3b2f99e.
|
The multiple commits following Jesper's approval are, largely, a trip to nowhere. At the time of the approval, Python CI tests were still failing. The intervening commits were for diagnostic purposes, to locate the source of the problem. It proved to be version incompatibilities with |
This PR supersedes #218. That PR led us to understand that we needed a fair bit of discovery work pertaining to how the scripts in this repo are used. (See also cancelled PSRE-2583). The work in that PR is incorporated here, and this PR contains answers from the ensuing discovery work.
This PR contains the results of experimentation with the AWS API Gateway on the
edx-playground-adminaccount per TNL-10899. It adds a new documentation file,docs/configuration_objects.md, with background information about API Gateway objects on AWS, and how they're used, and how they're accessed on the AWS console.Then, the PR adds scripts for the SRE team to use to add the Studio content API to the suite of APIs offered on our AWS API gateway. Capturing invocation information had not been part of the repo, but given that the repo's sole use is to assist with edX's management of its API Gateway depoloyments, it seems reasonable to include an audit trail within the repo. Each once-and-done script has a comment line at its head, intended to indicate whether the script has ever been run, and, if so, the date on which it was run.
Finally, the PR adds instructions for the SRE team to follow when updating the stage and prod environment API gateway settings to include the Studio content API. (See
SRE_request_studio_content_api_addition.md). It also includes rollback instructions, should something fail.Testing this PR
Step 1 - read the background info in this PR
Step 2 - log into the AWS console using the
edx-playground-adminroleStep 3- Use the CloudShell interface in the AWS console to run scripts on the API gateway's EC2 instance
Step 4- Run the scripts provided in the PR for the stage and prod environments on the playground's API Gateway
Notes:
gwtst.edx.us.org. You'll need to replace the hard-coded domain name in thedeploy_repo_to_prod_env_api_gw.shscript if you choose to work with the prod script variants on the playground. (Alternatively, work with the stage scripts and make the change there).