Commit Graph

95 Commits

Author SHA1 Message Date
YANO Tetsuro 7a68c19968 add markdown option syntax hightlight
add markdown option syntax hightlight
2019-12-30 10:37:45 +09:00
David Nuzik ef0adce478 Remove "k3s-db" and replace with "k3s" for dbname
- PostgreSQL/MySQL already have links to docs for DSN that users could reference to escape special chars
- Make suggested command work out of the box (won't run into an issue with unescaped dash in db name any more)
2019-12-13 11:07:42 -07:00
David Nuzik 68984d18bd Remove date from main _index.md page
- Most contributors won't know to always update this date
- If we actually  want to keep this date (which is rendered on the website) we need to ensure all contributors always update the date...
2019-12-13 11:00:22 -07:00
David Nuzik b3dc9f5cbc Fix broken hyperlink on networking-options page 2019-12-06 17:51:23 -07:00
David Nuzik 8b3a8a1139 Merge pull request #2063 from davidnuzik/networking
Add new network-options page to Install section
2019-12-06 17:44:30 -07:00
David Nuzik f8b2726d16 Tweaks and fix ip capitalization
- Make small tweaks Catherine suggested
- Capitalize ip
2019-12-06 17:42:18 -07:00
David Nuzik 269b6fc446 Resolve comments in PR
- Add step to Calico and Canal to check conf files on host to ensure settings took.
2019-12-06 14:12:11 -07:00
David Nuzik 189b8f6218 Add new network-options page to Install section
- Initial commit
- Adds this new page describing the flannel backend options and how to set up your own CNI
- Tweaks the existing Networking page
- Adds hyperlinks linking the two pages together.
Note: Intent is that the main Networking page is for CoreDNS, Traefik, ServiceLB, and in the future other general high level networking discussions. Whereas the "network-options" page under the Installation section is for specific things that should be considered at install-time for K3s such as the flannel backend or other CNIs.
2019-12-06 10:57:15 -07:00
David Nuzik 1c4dd738e1 Small tweak to K3s airgap page
- Changes the Install K3s code block so it's in two separate codeblocks so that someone won't confuse it as one command for each node.
2019-12-05 13:17:26 -07:00
Erik Wilson 53ed57efe3 Update k3s v1.0.0 Node Registration information 2019-11-20 13:40:46 -07:00
Craig Jellick 7493c0f5a8 Overhaul installation docs 2019-11-18 12:12:51 -07:00
David Nuzik c40800e9aa Merge pull request #2012 from davidnuzik/airgap-improvements
Air-Gap Improvements
2019-11-15 17:13:50 -07:00
David Nuzik 945a5bc419 Fix upgrading section make h1 header
- h1 header separates out from the steps for normal install
- easier to read and find special upgrading section for airgap
2019-11-15 16:43:16 -07:00
David Nuzik ef8f25e9ad Air-Gap Improvements
- Add additional steps such as for private registry
- Improve readability by clearly outlining steps
2019-11-15 16:39:55 -07:00
David Nuzik af6c148e8d remove duplicate "again" 2019-11-15 11:36:04 -07:00
David Nuzik c372765eba Change wording for node labels and taints
- Make it more clear that you can still modify / add / remove labels and taints, just not with k3s after node registration
You can still change these with the kubectl client, so the wording was changed to make this more clear to avoid confusion.
2019-11-15 11:32:49 -07:00
David Nuzik 72d10615c6 Capitalize k3s > K3s in all appropriate areas
- Don't capitalize if is in code block, url, backticks, etc.
2019-11-15 09:34:00 -07:00
David Nuzik ef07352df1 Update node req port info regarding metrics-server port 10250
- Also change the Networking page to instead link to the Networking seciton of the NOde Requirements page so we don't duplicate information in two areas.
2019-11-15 09:19:36 -07:00
David Nuzik e74c464560 Fix faq building question, point to correct url 2019-11-15 09:11:45 -07:00
David Nuzik a27c913ce6 Remove the "Prior v1.0.0" docs
- Based on discussion with the K3s team we decided to remove these completely
This is because everything prior to v1.0.0 is not GA and not officially supported. It's strongly recommended to use the v1.0.0 or newer version of K3s.
2019-11-14 15:58:12 -07:00
David Nuzik 0a2e829bfa fix 1 char typo on ha install page 2019-11-13 19:21:20 -07:00
David Nuzik 50f05276aa Tweaks to Traefik on Networking page
- Modify the Traefik sectoin so it's clear it's the ingress controller
- Make it clear what ports are use don the host (so can't use for HostPort or a strange NodePort setting)
- Small misc tweaks
2019-11-13 19:17:11 -07:00
David Nuzik 4b0b7e48a5 Merge pull request #1996 from davidnuzik/v1-changes
v1.0.0 tweaks to HA install page and update cli flags
2019-11-13 11:54:48 -07:00
David Nuzik 81b586457c Address comments
- Address all of Catherine's comments.
https://github.com/rancher/docs/pull/1996#pullrequestreview-316448418
2019-11-13 11:51:57 -07:00
David Nuzik 7532a043f9 Completely remove cli flags from single-server install page
- As discussed via slack with Craig, completely remove cli flags from this page
-- This content was not helpful. It's the same as running the --help flag we didn't provide any context or additional info.
-- At a later date we may cherry pick some of those cli flags and add more detail about them where necessary.
2019-11-12 19:12:10 -07:00
David Nuzik 1449325bca Address comments
- Remove the term "master" from everywhere in the docs. k3s servers are servers not "masters"
- Remove an uneeded section from the ha install page
- Misc small tweaks
2019-11-12 19:08:28 -07:00
David Nuzik a725da986b Add Metrics Server back in to config page but link to older config page
- Forgot about one comment Catherine had. I added a link to the older config page on the main config page.
2019-11-12 18:45:25 -07:00
David Nuzik eed95ec660 Add older-configuration section and put old metrics-server info there instead.
- Addresses comments in the PR adding to keep this content but move it.
- Added some context to this page and info about how v1.0.0 and newer has the metrics-server by default so this is clear to the user.
2019-11-12 18:41:22 -07:00
David Nuzik 44428a2d22 Add missing line to etcd tab 2019-11-12 18:31:08 -07:00
David Nuzik e6e43cf381 Add older-installations for ha prior to v1.0.0 and update main ha page
- Add an older-installations page, a child of the Installation main section to address older k3s versions different method for bringing up servers
- Modify the main HA install page so that we no longer list anything as experimental
-- Also update the page so we remove the Cluster Datastore Options section, compact this into a modified section of step 2 for bring up the master (server) nodes
-- Fix any wording, modify text so it's more readable and easier to follow.
2019-11-12 18:07:38 -07:00
David Nuzik 7a3bdd69f0 Remove metrics-server mention in configuration page
- We now includ our own metrics-server and thus standard kubectl top nodes, etc functionality works out of the box.
Since this works like standard k8s now with the top command, etc we don't need to document the custom-method to deploy metrics-server so we should simply remove this section.
2019-11-12 14:40:35 -07:00
David Nuzik 20b777634a Apply requested fixes
- Resolve all four comments posted by Catherine.
2019-11-12 12:16:39 -07:00
David Nuzik 8a836f724b Update HA Recommended Architecture image - fix arrows
- Fixes the direction of arrows in the iamge
- Addresses https://github.com/rancher/k3s/issues/1031#issuecomment-552670275
2019-11-12 11:07:39 -07:00
David Nuzik bc9e3c80f5 Update PGsql versions
- Only support what we have tested 10.7 and 11.5 and remove the "R1"
2019-11-11 17:44:39 -07:00
David Nuzik a51b259cc8 HA fixes for comments in GH issue
- Addresses 2 comments about the HA page:
https://github.com/rancher/k3s/issues/1031#issuecomment-552672334
https://github.com/rancher/k3s/issues/1031#issuecomment-552673219
2019-11-11 17:12:51 -07:00
David Nuzik 503e0f44fd Change Installation Options title to Installation 2019-11-11 17:05:18 -07:00
David Nuzik fcb6b782d0 Remove hyperkube
- We plan to eventually remove support for hyperkube so we will no longer document here.
2019-11-11 16:46:17 -07:00
David Nuzik 4aa6e14179 Resolve nitpicks / wordage in a couple of areas
- node-requirements "set" env var, not "pass"
- single-server remove duplicate "specific" word
- possibly some other minor tweaks
2019-11-11 16:25:52 -07:00
David Nuzik f45ceddfe5 Modify quick-start to remove cluster-secret and add to ha install guide
- This changes the quick-start guide so we just remove the K3S_CLUSTER_SECRET environemnt variable. It wasn't needed for a simple quick-start.
- I changed the ha install guide so that we mention the K3S_CLUSTER_SECRET / --cluster-secret in this area as it would be likely relevant here i.e. for auto-scaling node pools.
2019-11-11 16:00:14 -07:00
David Nuzik fdd5e01070 Adjust quick-start and install pages regarding downtime
- This makes changes to the quick-start and install guides that change wording around HA.
- Prevoiusly we only suggested HA for ALL production enviornments this is no longer the case. Single-server is okay if some down time is tolerable.
- This commit includes a couple of misc tweaks to fix wording in related areas.
2019-11-11 14:59:51 -07:00
David Nuzik 85e94ef3ea Move "Upgrades" from Installation Options section to a new Upgrades section 2019-11-11 10:52:02 -07:00
David Nuzik 83f3ecd221 Improve k3s navigation / move content around (#1985)
* Move airgap from advanced to install

- move Air-Gap section in Advanced Options to Install Options
-- small tweak to the air-gap content but looks like may need more tweaks later
- update Installation Options _index.md so that it now lists "Air-Gap Installation" as an option with hyperlink

* Move airgap part 2 (actually del airgap from advanced)

Whoopsie. I forgot to remove the Air-Gap section from advanced in my last commit.
This simply deletes the Air-Gap section that used to be in the advanced page since we have moved the content to the installation/airgap section.

* Move ha backend options from configuration to install
- move storage backend options from the Configuration Info page to the Install Options (HA) page
-- small tweaks to content, very minor

* Move Uninstallation notes from advanced to install
- move note about Uninstallation from the Advanced Options page to Install Options main page
-- small tweaks to fix content and wording, very minor

* Fix and move upgrades content to main Install Options section
- In a previous commit, "Upgrades" section under the advanced section was mistakenly moved to the new airgap page
  This fixes that and moves this content to the main install options section.
-- Some content tweaks to make the wording better and fix things up.

* Move networking info from Configuration Info to new Networking section

- Move networking info from confiuration to networking (new section)

* Move networking port info from configuration to networking
- Move some networking/security port info from the configuration page to the new networking page.
Note: This info is also intentionally already duplicated on the Node Registration page as it has important info on ports that need to be open and accessible.

* REMOVE "Building from Source" section completely
- Remove the Building from Source section
- Add FAQ Q&A about this and link to the k3s README.md where this info will go
Note: This was done after some discussion a while back. The Building from Source section is important, but not for the majority of users as release binaries / curl script should be utilized to install k3s.
A separate PR will add this content into the main k3s README.md file which the FAQ question that was added references.

* Fixes for comments, tweak ha install heading names
- Resolves comments asking to change headings in 2 areas of ha install
- Removes ambiguity in these areas
2019-11-11 09:31:56 -08:00
Denise 2db635967e Merge pull request #1984 from davidnuzik/storage
Storage
2019-11-10 17:06:28 -08:00
David Nuzik 0977996e8d Misc fixes
Fix pv to pv claim, capitzalize PV and PVC in all appropriate areas.
Add a period to a line where it was missing.
2019-11-10 17:24:06 -07:00
David Nuzik 6427f8aa80 Add main body to storage _index.md
Adds content for the local path provisoner bundled with k3s and Longhorn.
Each exaplains the essentials to create a pvc and a pod that utilizes it.
2019-11-10 16:16:25 -07:00
Alexey Dushechkin 424140b760 Minor typo
Raspian -> Raspbian.

https://www.raspberrypi.org/downloads/raspbian/.
2019-11-10 08:14:45 -08:00
David Nuzik ea9d648aa1 Normalize page weights and initial add storage section
This tweaks the page weights so they make more sense.
We now have these in multiples of ten so we can easily move up or down new sections as we go beetween these numbers.
The Volumes and Storage section as added, intial only.
A separate commit will have the content for the Volumes and Storage page.
2019-11-08 16:29:23 -07:00
David Nuzik 81ef42a808 Merge pull request #1978 from davidnuzik/improve-ha
Improve ha install guide
2019-11-08 15:29:33 -07:00
David Nuzik b75e96b033 Update HA image 2019-11-08 15:05:48 -07:00
David Nuzik fe52fadc15 Remove first line 2019-11-08 14:48:53 -07:00