mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-05 08:17:04 +00:00
docs: specify container image in config
This commit is contained in:
parent
c4fa78c8d0
commit
40be2c7e0c
6 changed files with 8 additions and 10 deletions
2
.github/ISSUE_TEMPLATE/new-release.md
vendored
2
.github/ISSUE_TEMPLATE/new-release.md
vendored
|
@ -16,7 +16,7 @@ Please do not remove items from the checklist
|
|||
`git branch release-0.$MAJ master`
|
||||
- [ ] Prepare `release-0.$MAJ` release branch
|
||||
- [ ] Run `scripts/prepare-release.sh $VERSION` to turn references to point to the upcoming release
|
||||
(README, deployment templates, docs .md files, docs configuration, test/e2e flags)
|
||||
(README, deployment templates, docs configuration, test/e2e flags)
|
||||
- [ ] An OWNER runs
|
||||
`git tag -s $VERSION`
|
||||
and inserts the changelog into the tag description.
|
||||
|
|
|
@ -47,3 +47,6 @@ display_version_list: true
|
|||
# Release is used to make external links to point to the correct blobs in the
|
||||
# Github repo
|
||||
release: master
|
||||
|
||||
# Container image which to point to in the documentation
|
||||
container_image: gcr.io/k8s-staging-nfd/node-feature-discovery:master
|
||||
|
|
|
@ -155,7 +155,7 @@ Kubernetes API is not available. Thus, it is recommended to use `--no-publish`
|
|||
command line flag. E.g.
|
||||
|
||||
```bash
|
||||
$ export NFD_CONTAINER_IMAGE=gcr.io/k8s-staging-nfd/node-feature-discovery:master
|
||||
$ export NFD_CONTAINER_IMAGE={{ site.container_image }}
|
||||
$ docker run --rm --name=nfd-test ${NFD_CONTAINER_IMAGE} nfd-master --no-publish
|
||||
2019/02/01 14:48:21 Node Feature Discovery Master <NFD_VERSION>
|
||||
2019/02/01 14:48:21 gRPC server serving on port: 8080
|
||||
|
|
|
@ -19,7 +19,7 @@ To quickly view available command line flags execute `nfd-master --help`.
|
|||
In a docker container:
|
||||
|
||||
```bash
|
||||
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-master --help
|
||||
docker run {{ site.container_image }} nfd-master --help
|
||||
```
|
||||
|
||||
### -h, --help
|
||||
|
|
|
@ -19,7 +19,7 @@ To quickly view available command line flags execute `nfd-worker --help`.
|
|||
In a docker container:
|
||||
|
||||
```bash
|
||||
docker run gcr.io/k8s-staging-nfd/node-feature-discovery:master nfd-worker --help
|
||||
docker run {{ site.container_image }} nfd-worker --help
|
||||
```
|
||||
|
||||
### -h, --help
|
||||
|
|
|
@ -57,14 +57,9 @@ fi
|
|||
echo Patching docs/_config.yml
|
||||
sed -e s"/release:.*/release: $release/" \
|
||||
-e s"/version:.*/version: $docs_version/" \
|
||||
-e s"!container_image:.*!container_image: k8s.gcr.io/nfd/node-feature-discovery:$release!" \
|
||||
-i docs/_config.yml
|
||||
|
||||
# Patch container image repo
|
||||
echo Patching '*.md' files to refer to $container_image
|
||||
find . -path ./docs/vendor -prune -o -name '*.md' -print | xargs \
|
||||
sed -i -e s"!gcr.io/k8s-staging-nfd/node-feature-discovery:[[:alnum:]][[:alnum:].-]*!$container_image!" \
|
||||
-e s"!k8s.gcr.io/nfd/node-feature-discovery:[[:alnum:]][[:alnum:].-]*!$container_image!"
|
||||
|
||||
# Patch README
|
||||
echo Patching README.md to refer to $release
|
||||
sed s"!node-feature-discovery/v.*/!node-feature-discovery/$release/!" -i README.md
|
||||
|
|
Loading…
Add table
Reference in a new issue