GithubHelp home page GithubHelp logo

f5-agility-labs-xc's Introduction

F5 Agility Lab Template

Introduction

This repo contains a template that should be used when creating lab documentation for F5's Agility Labs.

Setup

  1. Download or git clone the f5-agility-lab-template
  2. Download and install Docker CE (https://docs.docker.com/engine/installation/)
  3. Build the sample docs ./containthedocs-build.sh. The first time you build a container (~1G in size) will be downloaded from Docker Hub.
  4. Open the docs/_build/html/index.html file on you system in a web browser

Configuration & Use

To use this template:

  1. Copy contents of this repo to a new directory cp -Rf . /path/to/your/docs
  2. cd /path/to/your/docs
  3. Edit docs/conf.py
  4. Modify the following lines:
    • classname = "Your Class Name"
    • github_repo = "https://github.com/f5devcentral/your-class-repo"
  5. Build docs ./containthedocs-build.sh (see Build Scripts below)
  6. Open the docs/_build/html/index.html file on you system in a web browser
  7. Edit the *.rst files as needed for your class
  8. Rebuild docs as needed using ./containthedocs-build.sh

Converting from Microsoft Word

To convert a .docx file from Microsoft Work to reStructuredText:

  1. Copy your .docx file into the f5-agility-lab-template directory
  2. Run ./containthedocs-convert.sh <filename.docx>
  3. Your converted file will be named filename.rst
  4. Images in your document will be extracted and placed in the media directory

Warning

While the document has been converted to rST format you will still need to refactor the rST to use the structure implemented in this template.

Build Scripts

The repo includes build scripts for common operations:

  • containthedocs-bash.sh: Run to container with a BASH prompt
  • containthedocs-build.sh: Build HTML docs using make -C docs html to docs/_build/html
  • containthedocs-clean.sh: Clean the build directory using make -C docs clean
  • containthedocs-cleanbuild.sh: Clean the build directory and build HTML docs using make -C docs clean html
  • containthedocs-convert.sh: Convert a Word .docx file to rST

f5-agility-labs-xc's People

Contributors

6a6d avatar aconley245 avatar aknot242 avatar anthonyf5 avatar bkoopari avatar boreal321 avatar chrismackinnon avatar danielcayer avatar djmistryman avatar dober-man avatar drpotters avatar f5danicami avatar glenwillms avatar jamesaffeld avatar johneudy avatar leonardosgithub avatar lesleycw avatar mikej81 avatar nettas avatar pmscheffler avatar prestonhashworth avatar pun1sher avatar reedshipley avatar robinmordasiewicz avatar russmalloypers avatar salinaf5 avatar stockerts avatar thnguyenf5 avatar tylerbrown7213 avatar valbuenahector avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

f5-agility-labs-xc's Issues

"Update Password" email misidentifies XC domain as "account name"

Voltera-login page asks for domain- F5 Distributed Cloud Console
volterra-lab-update-account-message-has-incorrect-descriptor

When I start the lab on UDF, I get a message from F5 Distributed Cloud telling me to 'Update Your Account' (See attached screenshots)

The message misidentifies the XC domain as the "account name" - I may be slow, but this caused confusion and delay.

The XC login page wants the user to specify the domain 'f5-xc-lab-sec' and to use the F5 email address as the account name. The best thing would be to correct the label used by the email message. Next best would be to update the lab guide to identify this error.

HTTP Load Balancer - "Advanced Configuration" is now "Other Settings"

In Lab 3 https://github.com/f5devcentral/f5-agility-labs-xc/blob/dev/docs/class1/lab3.rst

https://github.com/f5devcentral/f5-agility-labs-xc/blob/dev/docs/class1/lab3.rst#exercise-3-configure-local-vip
Task 3 Exercise 3: Configure Local VIP; the instructions say to go under "Advanced Configuration". This now appears to be called "Other Settings".

"Where to Advertise the VIP" is now called "VIP Advertisement"
The "Advertise Custom" option is now called "Custom"
Step 3, Next to "Custom Advertise VIP Configuration" click on "Show Advanced Fields" does not appear to be necessary as there is no "Show Advanced Fields" button to click.

https://github.com/f5devcentral/f5-agility-labs-xc/blob/dev/docs/class1/lab3.rst#exercise-4-configure-waf-policy
Exercise 4: Configure WAF Policy
The Security Configuration section in the console is before the "Other Settings" section, so maybe the WAF section shoul dcome first in the guide?

class 2 lab 2 Reviewing Signature-based Bot Strategies - asks us to edit object we haven't created

Task 1: Reviewing Signature-based Bot protection
2. on your App Firewall policy THAT DOESN'T EXIST <namespace>-appfw, click the three dots...

I just used the shared/base-appfw. I couldn't edit it, couldn't clone it.

I created a new object <namespace>-appfw with the signature-based bot protection and left all the defaults except for enabling enforcement. Signature-based bot protection was configured as specified in the lab guide.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.