Commit Graph

73 Commits

Author SHA1 Message Date
Abigail McCarthy 9efe14f6a7
Merge branch 'main' into update-page-weights 2023-02-22 10:38:34 -05:00
zhuzhenghao a21e1f7aa9 Clean up page distribute-credentials-secure 2023-02-22 15:19:06 +08:00
Shannon Kularathna 679d205d3d Clean up wording and remove duplicate content
Trim environment variable content in concept

- Remove steps and link to the relevant task
- Add a brief intro to task heading

Clean up wording about Secrets as env vars

- Improve clarity of the list items
- Improve clarity of the intro paragraph for invalid vars

Delete environment variable use case
2023-02-06 21:25:25 +00:00
Abigail McCarthy c4b70832dd Include index files 2023-01-17 09:14:01 -05:00
Shannon Kularathna 15e374d4f9 Edit mounted secrets wording
- Change heading levels
- Improve the intro sentence for the list
- Style edit for the list items
- Convert the limitations of explicit listing into a bullet list
- In the bullet list, clean up phrasing
- Remove the 'Read the secret data' bit. The existing steps on
  this page have the same instructions.
2022-11-25 20:44:08 +00:00
Shannon Kularathna b592215c13 Move mounted Secrets sections verbatim to task page 2022-11-25 20:22:39 +00:00
Kubernetes Prow Robot 17a4caa8c3
Merge pull request #35743 from crenshaw-dev/clarify-env-var-dependency-order
clarify that order matters in dependent environment variables
2022-09-12 04:19:24 -07:00
yanrongshi f6fa07357d fix some layout 2022-09-09 22:54:18 +08:00
Hu Shuai 9b7af96880 Fix broken link -- downward-api
Signed-off-by: Hu Shuai <hus.fnst@fujitsu.com>
2022-08-10 10:59:25 +08:00
Michael Crenshaw cde61ca477 clarify that order matters in dependent environment variables
Signed-off-by: Michael Crenshaw <michael_crenshaw@intuit.com>
2022-08-05 14:35:47 -04:00
Kubernetes Prow Robot 3a0d817bb8
Merge pull request #32400 from sftim/20220321_document_downward_api_concept
Revise downward API documentation
2022-06-16 23:38:31 -07:00
Mikey Boldt ab215b3cbd
Minor grammar fix
"an dependent" -> "a dependent"
2022-06-01 14:00:00 -05:00
Sean Wei 50b9fb29b0 Remove data-lang for command outputs 2022-05-28 20:08:49 +08:00
Tim Bannister 7f3604a949
Revise downward API documentation
- add a glossary entry
- add a concept page
- revise other documentation in light of above changes
2022-05-26 13:26:45 +01:00
Guangwen Feng d44cdef4d8 Fix an invalid link in downward-api-volume-expose-pod-information.md
Signed-off-by: Guangwen Feng <fenggw-fnst@fujitsu.com>
2022-05-25 10:20:39 +08:00
xin.li 6f0bc9a0a1 [en] modify link in define-command-argument-container
Signed-off-by: xin.li <xin.li@daocloud.io>
2022-04-29 19:07:13 +08:00
Qiming Teng 6149835647 Tweak the downward API volume task page
This PR drops some outdated information about very old Kubernetes versions.
The last section is improved so that readers get a better idea why those pointers are provided.
2022-03-14 08:10:07 +08:00
Shivam Singhal 7a2863b99a Cleanup notes in Define a Command and Arguments docs 2021-12-22 23:42:55 +02:00
Qiming Teng e9703497a1 Remove exec permission on markdown files
For some unknown reasons, we have got many markdown files with exec
permission. That is weird and risky.
2021-06-16 17:57:00 +08:00
Brad Jones 9ba5ddd01f Clarify language regarding environment variable order 2021-02-05 11:18:16 -07:00
Qiming Teng a11047c153 Clean PodPreset docs, examples and links 2021-01-14 13:26:29 +08:00
Derek Carr 6b4ab17902 Add documentation for downward API hugepages 2020-12-01 11:07:35 -05:00
Max Belsky 8cc80bf469
Update content/en/docs/tasks/inject-data-application/define-environment-variable-container.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-10-23 10:51:14 +03:00
Max Belsky dccbc5f3cd
Reduce steps count to list the env vars 2020-10-22 16:42:36 +03:00
Qiming Teng 740eb340d4 Fix links in the tasks section
This PR fixes links where the target is a redirection. The special case
is about minikube, which has been deleted recently. The dangling link
now points to `/docs/tasks/tools/` which makes no sense. This PR change
the target for `minikube` to `https://minikube.sigs.k8s.io/docs/`.
2020-10-22 15:01:45 +08:00
TAKAHASHI Shuuji c6a96128c4
Replace special quote characters with normal ones. 2020-08-11 21:05:22 +09:00
Qiming Teng 92ae1a9cf8 Tune links in tasks section (2/2) 2020-08-08 16:15:28 +08:00
Jerry Park 64f62106c1 Fix issue of document link in some documents 2020-07-05 22:46:08 +09:00
Kubernetes Prow Robot 9c196f9e09
Merge pull request #21811 from Cweiping/feature/add_interdependent_envvars
add define interdependent environment variables page
2020-07-03 21:00:48 -07:00
Weiping Cai 4490fe014f
use printf to replace printenv
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-07-01 14:48:38 +08:00
Cweiping e3f6541d0a
Apply suggestions from code review
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-20 16:35:35 +08:00
Weiping Cai 1253c3b39e
fix UNCHANGE_REFERENCE to UNCHANGED_REFERENCE,and use you to replace we
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-17 14:02:10 +08:00
Weiping Cai 5513c60b54
add define interdependent environment variables page
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-16 18:40:30 +08:00
Tim Bannister 74360fa8ee Add descriptions for tasks
Add description metadata for each task section (English localization).
For sections that only have one page, make sure that that sole page has
description metadata set.

This change helps prepare for the migration to the Docsy theme.
2020-06-15 20:47:26 +01:00
Tim Bannister e6537e4043 Tidy 'Distribute Credentials Securely Using Secrets'
- Separate out short arguments to kubectl exec

  Make it explicit that "-i" and "-t" are separate arguments to
  "kubectl exec".

  Readers who know about aggregating short arguments can figure the
  aggregation out for themselves.

- Fix /tidy Markdown
2020-06-11 23:44:55 +01:00
Kubernetes Prow Robot 350b0ffa85
Merge pull request #21553 from wawa0210/patch-1
Clarify the explanation when environment variables refer to each other
2020-06-11 05:30:56 -07:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
wawa 4bd73bee23
Update define-environment-variable-container.md
Enhanced environment variable application notes
2020-06-07 10:50:25 +08:00
Tim Bannister a2de95e243 Drop version check
All supported Kubernetes releases let you set environment variables for
Pods.
2020-05-24 12:04:31 +01:00
Tim Bannister 9b3e181f5a Reword environment variable task
- Use style guide convention for running commands
  Don't include the prompt, even for commands run inside a container
- Call a manifest a manifest
- tweak some wording
2020-05-24 12:03:02 +01:00
Sylvain COULOMBEL 224a6cacbf Improve task 'Distribute Credentials Securely Using Secrets' by showing pod output 2020-05-17 15:50:44 +02:00
Tim Bannister 58498dc3ca Reword PodPreset concept
- Note feature state for PodPreset
- Emphasize section on enabling PodPreset
- Omit version check
  Assume that the reader has a supported version of Kubernetes that
  includes PodPreset.
- List PodPreset as a task prerequisite
  PodPreset is an alpha feature; you can't follow the task page unless
  it's enabled.
2020-04-27 11:35:42 +01:00
Qiming Teng e0a03c0ebd
Resource name constraints (5) (#19122)
xref: #17969, #19099, #18746
2020-03-15 21:52:36 -07:00
tom1299 7ac1614f74
Harmonize Pod Preset tasks (#18128) 2020-03-11 01:33:36 -07:00
Richard Samuelson 844803a0c4
Remove contradictory statements (#19321)
Remove contradictory statements (Use a local tool trusted by your OS vs. recommend to use online base64 tool)
2020-02-27 01:15:20 -08:00
Tim Bannister 8b42027bbb
Revise version requirements (#18688)
Assume that the reader is running a version of Kubernetes that supports
the Secret resource.
2020-01-29 15:02:14 -08:00
tom1299 ffb37e6a70 Add missing article (#18707)
Added missing article in one of the sentences
2020-01-15 05:49:32 -08:00
Rahul Kumar Singh 20e31c3f5c Added More Base64 Tool (#17982)
I noticed this https://www.base64encode.org/ Tool is not working in the safari browser, So I added alternative tool that I found is working on safari and another browser.

Please Check Link that I added :)

Thanks
2020-01-08 05:57:40 -08:00
vishakha ef60d90397 enh: Adding a caution for external tool (#18002)
* Adding a caution for external tool

* Update content/en/docs/tasks/inject-data-application/distribute-credentials-secure.md

Co-Authored-By: Zach Corleissen <zacharysarah@users.noreply.github.com>
2019-12-13 02:48:56 -08:00
Manish Bansal 05231ff19d Documentation update (#16693)
* Documentation update

Fixed link and its description

* Corrected

* Incorporated review comment

* Incorporated review comment
2019-10-07 00:31:09 -07:00