Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

CDN in a Box Documentation#2954

Merged
dangogh merged 3 commits into
apache:masterfrom
ocket8888:ciab-docs
Oct 29, 2018
Merged

CDN in a Box Documentation#2954
dangogh merged 3 commits into
apache:masterfrom
ocket8888:ciab-docs

Conversation

@ocket8888
Copy link
Copy Markdown
Contributor

What does this PR do?

Adds documentation for the CDN in a Box project, updates infrastructure/cdn-in-a-box/README.md and minor fixes to a Dockerfile in ciab as well as removing now-unused recipes from the ciab Makefile

Which TC components are affected by this PR?

  • Documentation
  • Grove
  • Traffic Analytics
  • Traffic Monitor
  • Traffic Ops
  • Traffic Ops ORT
  • Traffic Portal
  • Traffic Router
  • Traffic Stats
  • Traffic Vault
  • CDN in a Box

What is the best way to verify this PR?

Build RPMs with the cdn-in-a-box makefile, build the docs, and read them and the README to make sure everything makes sense.

Check all that apply

  • This PR includes tests
  • This PR includes documentation updates
  • This PR includes an update to CHANGELOG.md
  • This PR includes all required license headers
  • This PR includes a database migration (ensure that migration sequence is correct)
  • This PR fixes a serious security flaw. Read more: www.apache.org/security

@asfgit
Copy link
Copy Markdown
Contributor

asfgit commented Oct 24, 2018

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/2649/
Test PASSed.

@asfgit
Copy link
Copy Markdown
Contributor

asfgit commented Oct 25, 2018

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/2651/
Test PASSed.

@rawlinp rawlinp added documentation related to documentation cdn-in-a-box related to the Docker-based CDN-in-a-Box system labels Oct 25, 2018
Comment thread docs/source/admin/quick_howto/ciab.rst Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sever -> several

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops :P

Comment thread docs/source/admin/quick_howto/index.rst Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not just a top-level "CDN in a Box" section alongside TO/TP? Burying it in an "Other" section makes it harder to find.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just didn't think there would be enough content to rival those, and I figured that tutorials that weren't directly in the scope of a TC component would be grouped under "Other". I'm not particularly attached to the organization method there.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say that the sections that are in there today don't really make sense either, especially since we've deprecated the Perl UI. They're just guides on how to use new stuff/features, lumped under the category of whichever UI was used at the time of implementation I'm guessing. I think CIAB is worthy of being at least alongside those. "Other" will just become a dumping ground of random stuff that should really be categorized into something better.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make it top-level. Once I finish with my API format overhaul, I'll start working on the how-to guides, and eventually nothing will be under "Traffic Ops", so every distinct guide can be its own top-level entry

Comment thread docs/source/admin/quick_howto/ciab.rst Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker-compose exec enroller /usr/bin/curl -L http://video.demo1.mycdn.ciab.test will accomplish the same and is a bit easier to digest.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually didn't know that. I'm thinking I should keep the sudo, because most default Docker installs don't automatically set any particular user's permissions such that they are able to access the dockerd without it

Comment thread docs/source/admin/quick_howto/ciab.rst Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if another docker-compose file is needed in addition to the default one, each must be on the cmd line with its own -f:

docker-compose -f docker-compose.yml -f docker-compose.testclient.yml up -d

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, nice catch

Comment thread infrastructure/cdn-in-a-box/README.md Outdated
@asfgit
Copy link
Copy Markdown
Contributor

asfgit commented Oct 26, 2018

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/2668/
Test PASSed.

@asfgit
Copy link
Copy Markdown
Contributor

asfgit commented Oct 26, 2018

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/2669/
Test PASSed.

@asfgit
Copy link
Copy Markdown
Contributor

asfgit commented Oct 26, 2018

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/2670/
Test PASSed.

@dangogh dangogh merged commit 84253b2 into apache:master Oct 29, 2018
@ocket8888 ocket8888 deleted the ciab-docs branch October 29, 2018 16:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cdn-in-a-box related to the Docker-based CDN-in-a-Box system documentation related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants