Skip to content

Commit d89d492

Browse files
authored
pre 152 tweaks (#1009)
- remove deprecated pdf generation process - minor release tweaks
1 parent bc27efb commit d89d492

File tree

2 files changed

+5
-338
lines changed

2 files changed

+5
-338
lines changed

.github/workflows/release.yml

Lines changed: 0 additions & 334 deletions
Original file line numberDiff line numberDiff line change
@@ -221,340 +221,6 @@ jobs:
221221
name: ${{ steps.build.outputs.release-asset-name }}
222222
path: ${{ steps.build.outputs.release-path }}
223223

224-
build-documentation:
225-
name: Build Documentation
226-
runs-on: ubuntu-latest
227-
outputs:
228-
documentation-archive-name: ${{ steps.setup.outputs.dir }}
229-
steps:
230-
- name: Checkout
231-
uses: actions/checkout@v2
232-
- name: Install xetex
233-
run: |
234-
sudo apt-get install texlive-xetex
235-
sudo apt install librsvg2-bin
236-
sudo apt install 'fonts-dejavu*'
237-
238-
- name: Setup Env
239-
id: setup
240-
env:
241-
PREFIX: AWS-SEA
242-
SUFFIX: Documentation
243-
run: |
244-
mkdir ${PREFIX}-${SUFFIX}
245-
echo ::set-output name=prefix::$(echo "${PREFIX}")
246-
echo ::set-output name=suffix::$(echo "${SUFFIX}")
247-
echo ::set-output name=dir::$(echo "${PREFIX}-${SUFFIX}")
248-
249-
- name: PDF output 0
250-
uses: docker://pandoc/latex:2.10
251-
with:
252-
args: >
253-
--output=${{ steps.setup.outputs.dir }}/0-${{ steps.setup.outputs.prefix }}-Solution-Summary.pdf
254-
--from=gfm
255-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
256-
-V linkcolor:blue
257-
-V geometry:paperwidth=8.5in
258-
-V geometry:paperheight=11in
259-
-V geometry:margin=.8in
260-
-V documentclass=report
261-
--pdf-engine=xelatex
262-
README.md
263-
264-
- name: PDF output 1
265-
uses: docker://pandoc/latex:2.10
266-
with:
267-
args: >
268-
--output=${{ steps.setup.outputs.dir }}/1-${{ steps.setup.outputs.prefix }}-Installation-Guide.pdf
269-
--from=gfm
270-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
271-
-V linkcolor:blue
272-
-V geometry:paperwidth=8.5in
273-
-V geometry:paperheight=11in
274-
-V geometry:margin=.8in
275-
-V documentclass=report
276-
--pdf-engine=xelatex
277-
docs/installation/installation.md
278-
279-
- name: PDF output 1a
280-
uses: docker://pandoc/latex:2.10
281-
with:
282-
args: >
283-
--output=${{ steps.setup.outputs.dir }}/1a-${{ steps.setup.outputs.prefix }}-v150-Upgrade-Guide.pdf
284-
--from=gfm
285-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
286-
-V linkcolor:blue
287-
-V geometry:paperwidth=8.5in
288-
-V geometry:paperheight=11in
289-
-V geometry:margin=.8in
290-
-V documentclass=report
291-
--pdf-engine=xelatex
292-
docs/installation/v150-Upgrade.md
293-
294-
- name: PDF output 2
295-
uses: docker://pandoc/latex:2.10
296-
with:
297-
args: >
298-
--output=${{ steps.setup.outputs.dir }}/2-${{ steps.setup.outputs.prefix }}-Ops-FAQ.pdf
299-
--from=gfm
300-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
301-
-V linkcolor:blue
302-
-V geometry:paperwidth=8.5in
303-
-V geometry:paperheight=11in
304-
-V geometry:margin=.8in
305-
-V documentclass=report
306-
--pdf-engine=xelatex
307-
docs/faq/faq.md
308-
309-
- name: Copy file output 3
310-
run: |
311-
cp docs/architectures/AWS_Diagrams_Account_Network_VPC.pdf ${{ steps.setup.outputs.dir }}/3-${{ steps.setup.outputs.prefix }}-Diagrams_Account_Network_VPC.pdf
312-
313-
- name: PDF output 4a
314-
uses: docker://pandoc/latex:2.10
315-
with:
316-
args: >
317-
--output=${{ steps.setup.outputs.dir }}/4a-${{ steps.setup.outputs.prefix }}-Config-File-Customization.pdf
318-
--from=gfm
319-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
320-
-V linkcolor:blue
321-
-V geometry:paperwidth=8.5in
322-
-V geometry:paperheight=11in
323-
-V geometry:margin=.8in
324-
-V documentclass=report
325-
--pdf-engine=xelatex
326-
docs/installation/customization-index.md
327-
328-
- name: Copy file output 4b
329-
run: |
330-
cp reference-artifacts/SAMPLE_CONFIGS/config.example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.example.json
331-
332-
- name: Copy file output 4b1
333-
run: |
334-
cp reference-artifacts/SAMPLE_CONFIGS/config.lite-VPN-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.lite-VPN-example.json
335-
336-
- name: Copy file output 4b2
337-
run: |
338-
cp reference-artifacts/SAMPLE_CONFIGS/config.multi-region-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.multi-region-example.json
339-
340-
- name: Copy file output 4b3
341-
run: |
342-
cp reference-artifacts/SAMPLE_CONFIGS/config.ultralite-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.ultralite-example.json
343-
344-
- name: Copy file output 4b4
345-
run: |
346-
cp reference-artifacts/SAMPLE_CONFIGS/config.example-oldIP.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.example-oldIP.json
347-
348-
- name: Copy file output 4b5
349-
run: |
350-
cp reference-artifacts/SAMPLE_CONFIGS/config.lite-CTNFW-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.lite-CTNFW-example.json
351-
352-
- name: Copy file output 4b6
353-
run: |
354-
cp reference-artifacts/SAMPLE_CONFIGS/config.lite-GWLB-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.lite-GWLB-example.json
355-
356-
- name: Copy file output 4b7
357-
run: |
358-
cp reference-artifacts/SAMPLE_CONFIGS/config.lite-NFW-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.lite-NFW-example.json
359-
360-
- name: Copy file output 4b8
361-
run: |
362-
cp reference-artifacts/SAMPLE_CONFIGS/config.lite-VPN-example-oldIP.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.lite-VPN-example-oldIP.json
363-
364-
- name: Copy file output 4b9
365-
run: |
366-
cp reference-artifacts/SAMPLE_CONFIGS/config.test-example.json ${{ steps.setup.outputs.dir }}/4b-${{ steps.setup.outputs.prefix }}-config.test-example.json
367-
368-
- name: PDF output 4c
369-
uses: docker://pandoc/latex:2.10
370-
with:
371-
args: >
372-
--output=${{ steps.setup.outputs.dir }}/4c-${{ steps.setup.outputs.prefix }}-Multi-file-Config-Capabilities.pdf
373-
--from=gfm
374-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
375-
-V linkcolor:blue
376-
-V geometry:paperwidth=8.5in
377-
-V geometry:paperheight=11in
378-
-V geometry:margin=.8in
379-
-V documentclass=report
380-
--pdf-engine=xelatex
381-
docs/installation/multi-file-config-capabilities.md
382-
383-
- name: PDF output 4d
384-
uses: docker://pandoc/latex:2.10
385-
with:
386-
args: >
387-
--output=${{ steps.setup.outputs.dir }}/4d-${{ steps.setup.outputs.prefix }}-Config-Sample-Snippets.pdf
388-
--from=gfm
389-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
390-
-V linkcolor:blue
391-
-V geometry:paperwidth=8.5in
392-
-V geometry:paperheight=11in
393-
-V geometry:margin=.8in
394-
-V documentclass=report
395-
--pdf-engine=xelatex
396-
./reference-artifacts/SAMPLE_CONFIGS/sample_snippets.md
397-
398-
- name: Copy file output 4e
399-
run: |
400-
cp reference-artifacts/Third-Party/firewall-example-A-A-multitunnel.txt ${{ steps.setup.outputs.dir }}/4e-${{ steps.setup.outputs.prefix }}-firewall-example-A-A-multitunnel.txt
401-
402-
- name: PDF output 4f
403-
uses: docker://pandoc/latex:2.10
404-
with:
405-
args: >
406-
--output=${{ steps.setup.outputs.dir }}/4f-${{ steps.setup.outputs.prefix }}-Firewall-config-Customizations.pdf
407-
--from=gfm
408-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
409-
-V linkcolor:blue
410-
-V geometry:paperwidth=8.5in
411-
-V geometry:paperheight=11in
412-
-V geometry:margin=.8in
413-
-V documentclass=report
414-
--pdf-engine=xelatex
415-
./reference-artifacts/SAMPLE_CONFIGS/firewall_file_available_variables.md
416-
417-
- name: PDF output 4g
418-
uses: docker://pandoc/latex:2.10
419-
with:
420-
args: >
421-
--output=${{ steps.setup.outputs.dir }}/4g-${{ steps.setup.outputs.prefix }}-logging-locations.pdf
422-
--from=gfm
423-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
424-
-V linkcolor:blue
425-
-V geometry:paperwidth=11in
426-
-V geometry:paperheight=8.5in
427-
-V geometry:margin=.8in
428-
-V documentclass=report
429-
--pdf-engine=xelatex
430-
docs/architectures/pbmm/log-file-locations.md
431-
432-
- name: PDF output 4h
433-
uses: docker://pandoc/latex:2.10
434-
with:
435-
args: >
436-
--output=${{ steps.setup.outputs.dir }}/4h-${{ steps.setup.outputs.prefix }}-What-Where.pdf
437-
--from=gfm
438-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
439-
-V linkcolor:blue
440-
-V geometry:paperwidth=11in
441-
-V geometry:paperheight=8.5in
442-
-V geometry:margin=.8in
443-
-V documentclass=report
444-
--pdf-engine=xelatex
445-
docs/installation/what-we-do-where.md
446-
447-
- name: PDF output 4i
448-
uses: docker://pandoc/latex:2.10
449-
with:
450-
args: >
451-
--output=${{ steps.setup.outputs.dir }}/4i-${{ steps.setup.outputs.prefix }}-Public-Workload-Fortigate.pdf
452-
--from=gfm
453-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
454-
-V linkcolor:blue
455-
-V geometry:paperwidth=8.5in
456-
-V geometry:paperheight=11in
457-
-V geometry:margin=.8in
458-
-V documentclass=report
459-
--pdf-engine=xelatex
460-
docs/installation/guides/public-facing-workload-via-fortigate.md
461-
462-
- name: PDF output 4j
463-
uses: docker://pandoc/latex:2.10
464-
with:
465-
args: >
466-
--output=${{ steps.setup.outputs.dir }}/4j-${{ steps.setup.outputs.prefix }}-State-Machine-Inputs.pdf
467-
--from=gfm
468-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
469-
-V linkcolor:blue
470-
-V geometry:paperwidth=8.5in
471-
-V geometry:paperheight=11in
472-
-V geometry:margin=.8in
473-
-V documentclass=report
474-
--pdf-engine=xelatex
475-
docs/installation/sm_inputs.md
476-
477-
- name: PDF output 4k
478-
uses: docker://pandoc/latex:2.10
479-
with:
480-
args: >
481-
--output=${{ steps.setup.outputs.dir }}/4k-${{ steps.setup.outputs.prefix }}-Object-Naming.pdf
482-
--from=gfm
483-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
484-
-V linkcolor:blue
485-
-V geometry:paperwidth=8.5in
486-
-V geometry:paperheight=11in
487-
-V geometry:margin=.8in
488-
-V documentclass=report
489-
--pdf-engine=xelatex
490-
docs/installation/object-naming.md
491-
492-
- name: PDF output 4l
493-
uses: docker://pandoc/latex:2.10
494-
with:
495-
args: >
496-
--output=${{ steps.setup.outputs.dir }}/4l-${{ steps.setup.outputs.prefix }}-ALZ-Import-Account.pdf
497-
--from=gfm
498-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
499-
-V linkcolor:blue
500-
-V geometry:paperwidth=8.5in
501-
-V geometry:paperheight=11in
502-
-V geometry:margin=.8in
503-
-V documentclass=report
504-
--pdf-engine=xelatex
505-
docs/operations/operations-import-ALZAccount.md
506-
507-
- name: PDF output 5
508-
uses: docker://pandoc/latex:2.10
509-
with:
510-
args: >
511-
--output=${{ steps.setup.outputs.dir }}/5-${{ steps.setup.outputs.prefix }}-Operations-Troubleshooting-Guide.pdf
512-
--from=gfm
513-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
514-
-V linkcolor:blue
515-
-V geometry:paperwidth=8.5in
516-
-V geometry:paperheight=11in
517-
-V geometry:margin=.8in
518-
-V documentclass=report
519-
--pdf-engine=xelatex
520-
docs/operations/operations-troubleshooting-guide.md
521-
522-
- name: PDF output 6
523-
uses: docker://pandoc/latex:2.10
524-
with:
525-
args: >
526-
--output=${{ steps.setup.outputs.dir }}/6-${{ steps.setup.outputs.prefix }}-Developer-Guide.pdf
527-
--from=gfm
528-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
529-
-V linkcolor:blue
530-
-V geometry:paperwidth=8.5in
531-
-V geometry:paperheight=11in
532-
-V geometry:margin=.8in
533-
-V documentclass=report
534-
--pdf-engine=xelatex
535-
docs/developer/developer-guide.md
536-
537-
- name: PDF output 7
538-
uses: docker://pandoc/latex:2.10
539-
with:
540-
args: >
541-
--output=${{ steps.setup.outputs.dir }}/7-${{ steps.setup.outputs.prefix }}-PBMM-Architecture.pdf
542-
--from=gfm
543-
--resource-path=.:docs/architectures/pbmm:docs/installation:docs/operations
544-
-V linkcolor:blue
545-
-V geometry:paperwidth=8.5in
546-
-V geometry:paperheight=11in
547-
-V geometry:margin=.8in
548-
-V documentclass=report
549-
--pdf-engine=xelatex
550-
docs/architectures/pbmm/architecture.md
551-
552-
- name: Upload Artifact
553-
uses: actions/upload-artifact@v2
554-
with:
555-
name: ${{ steps.setup.outputs.dir }}
556-
path: ${{ steps.setup.outputs.dir }}/
557-
558224
upload-archive-to-release:
559225
# We don't want to upload artifact to the release if the workflow was dispatched manually
560226
if: github.event_name != 'workflow_dispatch'

src/mkdocs/docs/installation/install.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## 1.1. Overview
44

5-
**_We encourage customers installing the Accelerator to get the support of their local AWS account team (SA, TAM, CSM, ProServe) to assist with the installation of the Accelerator, as the Accelerator leverages, deploys, or orchestrates over 30 different AWS services._**
5+
**_We encourage customers installing the Accelerator to get the support of their local AWS account team (SA, TAM, CSM, ProServe) to assist with the installation of the Accelerator, as the Accelerator leverages, deploys, or orchestrates over 50 different AWS services._**
66

7-
_Users are strongly encouraged to also read the [Accelerator Operations/Troubleshooting Guide](../operations/index.md) before installation. The Operations/Troubleshooting Guide provides details as to what is being performed at each stage of the installation process, including detailed troubleshooting guidance._
7+
_Users are strongly encouraged to also read the [Accelerator Operations/Troubleshooting Guide](../operations/index.md) before installation and the [FAQ](../faq/index.md) while waiting for the installation to complete. The Operations/Troubleshooting Guide provides details as to what is being performed at each stage of the installation process, including detailed troubleshooting guidance._
88

99
These installation instructions assume one of the prescribed architectures is being deployed.
1010

@@ -15,6 +15,7 @@ These installation instructions assume one of the prescribed architectures is be
1515
- Management or root AWS Organization account (the AWS Accelerator cannot be deployed in an AWS sub-account)
1616
- No additional AWS accounts need to be pre-created before Accelerator installation
1717
- If required, a limit increase to support your desired number of new AWS sub-accounts (default limit is 10 sub-accounts)
18+
- **recent changes to new AWS account limits are causing accelerator installation failures, please work with your local account team to increase your limits**
1819
- Valid Accelerator configuration file, updated to reflect your requirements (see below)
1920
- Determine your primary or Accelerator `control` or `home` region, this is the AWS region in which you will most often operate
2021
- Government of Canada customers are still required to do a standalone installation at this time, please request standalone installation instructions from your Account SA or TAM
@@ -212,7 +213,7 @@ Multiple options exist for downloading the GitHub Accelerator codebase and pushi
212213
- Do NOT download the code off the main GitHub branch, this will leave you in a completely unsupported state (and with beta code)
213214
3. Push the extracted codebase into the newly created CodeCommit repository, maintaining the file/folder hierarchy
214215
4. Set the default CodeCommit branch for the new repository to main
215-
5. Create a branch following the Accelerator naming format for your release (i.e. `release/v1.5.1-a`)
216+
5. Create a branch following the Accelerator naming format for your release (i.e. `release/v1.5.2`)
216217

217218
### 1.4.3. AWS Internal (Employee) Accounts Only
218219

@@ -315,7 +316,7 @@ If deploying to an internal AWS employee account and installing the solution wit
315316
- Add an `Email` address to be used for State Machine Status notification
316317
- The `GitHub Branch` should point to the release you selected
317318
- if upgrading, change it to point to the desired release
318-
- the latest stable branch is currently `release/v1.5.1-a`, case sensitive
319+
- the latest stable branch is currently `release/v1.5.2`, case sensitive
319320
- click `Next`
320321
7. Finish deploying the stack
321322
- Apply a tag on the stack, Key=`Accelerator`, Value=`ASEA` (case sensitive).

0 commit comments

Comments
 (0)