starlingx/docs
Code Issues Proposed changes

Replace container tags

Browse Source 
Replace hard coded tag values with subsitutions

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I76aa5e8dc1870f5496b303f482a651d524fea3ce
This commit is contained in:
Ron Stone 2023-01-30 10:19:18 -05:00
parent 89377d0c63
commit 810927b055
12 changed files with 112 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/_includes/installing-and-provisioning-the-central-cloud.rest
View File

@ -2,7 +2,7 @@
.. deployment-scenario-begin
.. deployment-scenario-end
.. code-block:: none
.. parsed-literal::
system_mode: duplex
distributed_cloud_role: systemcontroller
@ -14,5 +14,5 @@
additional_local_registry_images:
- quay.io/external_storage/rbd-provisioner:v2.1.1-k8s1.11
- docker.io/starlingx/ceph-config-helper:ubuntu_bionic-20220802
- quay.io/external_storage/rbd-provisioner:|v_external_storage-rbd-provisioner|
- docker.io/starlingx/ceph-config-helper:|v_openstackhelm-ceph-config-helper|

153
doc/source/_vendor/container-subs-stx.txt
View File

@ -1,103 +1,112 @@
.. |v_armada-image| replace:: stx.7.0-v1.0.0
.. |v_armada| replace:: ddbdd7256c20f138737f6cbd772312f7a19f58b8-ubuntu_bionic
.. |v_airshipit-armada| replace:: ddbdd7256c20f138737f6cbd772312f7a19f58b8-ubuntu_bionic
.. |v_calico-cni| replace:: v3.24.0
.. |v_calico-kube-controllers| replace:: v3.24.0
.. |v_calico-node| replace:: v3.24.0
.. |v_calico-pod2daemon-flexvol| replace:: v3.22.2
.. |v_cdi-apiserver| replace:: v1.54.0
.. |v_cdi-cloner| replace:: v1.54.0
.. |v_cdi-controller| replace:: v1.54.0
.. |v_cdi-importer| replace:: v1.54.0
.. |v_cdi-operator| replace:: v1.54.0
.. |v_cdi-uploadproxy| replace:: v1.54.0
.. |v_cdi-uploadserver| replace:: v1.54.0
.. |v_ceph-ceph| replace:: v16.2.9
.. |v_cephcsi-cephcsi| replace:: v3.6.2
.. |v_cephfs-provisioner| replace:: v2.1.0-k8s1.11
.. |v_cert-manager-acmesolver| replace:: v1.7.1
.. |v_cert-manager-cainjector| replace:: v1.7.1
.. |v_cert-manager-controller| replace:: v1.7.1
.. |v_cert-manager-ctl| replace:: v1.7.1
.. |v_cert-manager-webhook| replace:: v1.7.1
.. |v_controller| replace:: v1.1.1
.. |v_coredns-coredns| replace:: v1.8.6
.. |v_coredns| replace:: 1.7.0
.. |v_curator| replace:: 5.7.6
.. |v_curl| replace:: 7.77.0
.. |v_curlimages-curl| replace:: 7.77.0
.. |v_defaultbackend-amd64| replace:: 1.5
.. |v_defaultbackend| replace:: 1.4
.. |v_dex| replace:: v2.31.1
.. |v_dexidp-dex| replace:: v2.31.1
.. |v_etcd| replace:: 3.5.3-0
.. |v_gpsd| replace:: 3.23.1
.. |v_grpc-tsyncd| replace:: 2.1.2.8
.. |v_helm-controller| replace:: v0.27.0
.. |v_external_storage-cephfs-provisioner| replace:: v2.1.0-k8s1.11
.. |v_external_storage-rbd-provisioner| replace:: v2.1.1-k8s1.11
.. |v_fluxcd-helm-controller| replace:: v0.27.0
.. |v_fluxcd-source-controller| replace:: v0.32.1
.. |v_google_containers-kubernetes-dashboard-init-amd64| replace:: v1.0.0
.. |v_hashicorp-vault-csi-provider| replace:: 0.4.0
.. |v_hashicorp-vault-k8s| replace:: 0.14.2
.. |v_hashicorp-vault| replace:: 1.9.2
.. |v_helm-tiller| replace:: v2.16.9
.. |v_ingress-nginx-controller| replace:: v1.1.1
.. |v_ingress-nginx-kube-webhook-certgen| replace:: v1.1.1
.. |v_install-cni| replace:: 1.13.3
.. |v_intel-fpga-plugin| replace:: stx.3.0-v0.11.0-103-g4f28657
.. |v_istio-install-cni| replace:: 1.13.3
.. |v_istio-operator| replace:: 1.13.3
.. |v_istio-pilot| replace:: 1.13.3
.. |v_istio-proxyv2| replace:: 1.13.3
.. |v_jetstack-cert-manager-acmesolver| replace:: v1.7.1
.. |v_jetstack-cert-manager-cainjector| replace:: v1.7.1
.. |v_jetstack-cert-manager-controller| replace:: v1.7.1
.. |v_jetstack-cert-manager-ctl| replace:: v1.7.1
.. |v_jetstack-cert-manager-webhook| replace:: v1.7.1
.. |v_jettech-kube-webhook-certgen| replace:: v1.5.0
.. |v_k8scsi-snapshot-controller| replace:: v2.0.0-rc2
.. |v_k8snetworkplumbingwg-multus-cni| replace:: v3.9.2
.. |v_k8snetworkplumbingwg-sriov-cni| replace:: v2.6.3
.. |v_k8snetworkplumbingwg-sriov-network-device-plugin| replace:: v3.5.1
.. |v_k8s-staging-sig-storage-csi-provisioner| replace:: v3.1.0
.. |v_kiali| replace:: v1.45.0
.. |v_kiali-kiali| replace:: v1.45.0
.. |v_kube-apiserver| replace:: v1.24.4
.. |v_kubebuilder-kube-rbac-proxy| replace:: v0.13.1
.. |v_kube-controller-manager| replace:: v1.24.4
.. |v_kube-proxy| replace:: v1.24.4
.. |v_kube-rbac-proxy| replace:: v0.11.0
.. |v_kubernetes-entrypoint| replace:: v0.3.1
.. |v_kube-scheduler| replace:: v1.24.4
.. |v_locationservice-base| replace:: stx.8.0-v2.0.0
.. |v_metrics-server| replace:: v0.6.1
.. |v_n3000-opae| replace:: stx.8.0-v1.0.2
.. |v_node-feature-discovery| replace:: v0.8.1
.. |v_notificationclient-base| replace:: stx.8.0-v2.0.2
.. |v_notificationservice-base| replace:: stx.8.0-v2.0.2
.. |v_kubevirt-cdi-apiserver| replace:: v1.54.0
.. |v_kubevirt-cdi-cloner| replace:: v1.54.0
.. |v_kubevirt-cdi-controller| replace:: v1.54.0
.. |v_kubevirt-cdi-importer| replace:: v1.54.0
.. |v_kubevirt-cdi-operator| replace:: v1.54.0
.. |v_kubevirt-cdi-uploadproxy| replace:: v1.54.0
.. |v_kubevirt-cdi-uploadserver| replace:: v1.54.0
.. |v_kubevirt-virt-api| replace:: v0.53.1
.. |v_kubevirt-virt-controller| replace:: v0.53.1
.. |v_kubevirt-virt-handler| replace:: v0.53.1
.. |v_kubevirt-virt-launcher| replace:: v0.53.1
.. |v_kubevirt-virt-operator| replace:: v0.53.1
.. |v_library-postgres| replace:: 9.6
.. |v_library-redis| replace:: 7.0.5-alpine3.16
.. |v_metrics-server-metrics-server| replace:: v0.6.1
.. |v_netapp-trident-autosupport| replace:: 22.07
.. |v_netapp-trident| replace:: 22.07.0
.. |v_nfd-node-feature-discovery| replace:: v0.8.1
.. |v_openstackhelm-ceph-config-helper| replace:: ubuntu_bionic-20220802
.. |v_operator| replace:: 1.13.3
.. |v_oranscinf-pti-o2imsdms| replace:: 2.0.0
.. |v_pause| replace:: 3.7
.. |v_phc2sys| replace:: 3.1.1
.. |v_pilot| replace:: 1.13.3
.. |v_portieris| replace:: stx.5.0-v0.7.0
.. |v_postgres| replace:: 9.6
.. |v_portieris-portieris| replace:: v0.13.1
.. |v_rabbitmq| replace:: 3.8.11-management
.. |v_rbd-provisioner| replace:: v2.1.1-k8s1.11
.. |v_redis| replace:: 7.0.5-alpine3.16
.. |v_rook-ceph| replace:: v1.9.6
.. |v_rvmc| replace:: stx.8.0-v1.0.1
.. |v_security-profiles-operator-security-profiles-operator| replace:: v0.6.0
.. |v_sig-storage-csi-attacher| replace:: v3.5.0
.. |v_sig-storage-csi-node-driver-registrar| replace:: v2.5.1
.. |v_sig-storage-csi-provisioner| replace:: v3.2.1
.. |v_sig-storage-csi-resizer| replace:: v1.5.0
.. |v_sig-storage-csi-snapshotter| replace:: v6.0.1
.. |v_snapshot-controller| replace:: v2.0.0-rc2
.. |v_source-controller| replace:: v0.32.1
.. |v_sriov-fec-daemon| replace:: stx.8.0-v2.5.0
.. |v_sriov-fec-labeler| replace:: stx.8.0-v2.5.0
.. |v_sriov-fec-operator| replace:: stx.8.0-v2.5.0
.. |v_silicom-gpsd| replace:: 3.23.1
.. |v_silicom-grpc-tsyncd| replace:: 2.1.2.8
.. |v_silicom-phc2sys| replace:: 3.1.1
.. |v_silicom-tsyncd| replace:: 2.1.2.8
.. |v_silicom-tsync_extts| replace:: 1.0.0
.. |v_stackanetes-kubernetes-entrypoint| replace:: v0.3.1
.. |v_starlingx-armada-image| replace:: stx.7.0-v1.0.0
.. |v_starlingx-ceph-config-helper| replace:: v1.15.0
.. |v_stx-audit| replace:: stx.8.0-v1.0.4
.. |v_stx-centos-dev| replace:: stx.7.0-v1.0.0
.. |v_stx-centos-tools-dev| replace:: stx.7.0-v1.0.1
.. |v_stx-debian-dev| replace:: stx.8.0-v1.0.3
.. |v_stx-debian-tools-dev| replace:: stx.8.0-v1.0.3
.. |v_stx-fm-rest-api| replace:: stx.8.0-v1.0.0
.. |v_stx-fm-subagent| replace:: stx.8.0-v1.0.0
.. |v_stx-fm-trap-subagent| replace:: stx.8.0-v1.0.0
.. |v_stx-kubevirt-app| replace:: stx.8.0-v0.53.1
.. |v_stx-metrics-server-sample-app| replace:: stx.7.0-v1.0.0
.. |v_stx-oidc-client| replace:: stx.8.0-v1.0.5
.. |v_stx-platformclients| replace:: stx.8.0-v1.5.9
.. |v_stx-snmp| replace:: stx.8.0-v1.0.0
.. |v_stx-vault-manager| replace:: stx.5.0-v1.18.3
.. |v_tiller| replace:: v2.16.9
.. |v_trident-autosupport| replace:: 22.07
.. |v_trident| replace:: 22.07.0
.. |v_tsyncd| replace:: 2.1.2.8
.. |v_tsync_extts| replace:: 1.0.0
.. |v_vault-csi-provider| replace:: 0.4.0
.. |v_vault| replace:: 1.9.2
.. |v_virt-api| replace:: v0.53.1
.. |v_virt-controller| replace:: v0.53.1
.. |v_virt-handler| replace:: v0.53.1
.. |v_virt-launcher| replace:: v0.53.1
.. |v_virt-operator| replace:: v0.53.1
.. |v_starlingx-intel-fpga-plugin| replace:: stx.3.0-v0.11.0-103-g4f28657
.. |v_starlingx-locationservice-base| replace:: stx.8.0-v2.0.0
.. |v_starlingx-n3000-opae| replace:: stx.8.0-v1.0.2
.. |v_starlingx-notificationclient-base| replace:: stx.8.0-v2.0.2
.. |v_starlingx-notificationservice-base| replace:: stx.8.0-v2.0.2
.. |v_starlingx-rvmc| replace:: stx.8.0-v1.0.1
.. |v_starlingx-sriov-fec-daemon| replace:: stx.8.0-v2.5.0
.. |v_starlingx-sriov-fec-labeler| replace:: stx.8.0-v2.5.0
.. |v_starlingx-sriov-fec-operator| replace:: stx.8.0-v2.5.0
.. |v_starlingx-stx-audit| replace:: stx.8.0-v1.0.4
.. |v_starlingx-stx-centos-dev| replace:: stx.7.0-v1.0.0
.. |v_starlingx-stx-centos-tools-dev| replace:: stx.7.0-v1.0.1
.. |v_starlingx-stx-debian-dev| replace:: stx.8.0-v1.0.3
.. |v_starlingx-stx-debian-tools-dev| replace:: stx.8.0-v1.0.3
.. |v_starlingx-stx-fm-rest-api| replace:: stx.8.0-v1.0.0
.. |v_starlingx-stx-fm-subagent| replace:: stx.8.0-v1.0.0
.. |v_starlingx-stx-fm-trap-subagent| replace:: stx.8.0-v1.0.0
.. |v_starlingx-stx-kubevirt-app| replace:: stx.8.0-v0.53.1
.. |v_starlingx-stx-metrics-server-sample-app| replace:: stx.7.0-v1.0.0
.. |v_starlingx-stx-oidc-client| replace:: stx.8.0-v1.0.5
.. |v_starlingx-stx-platformclients| replace:: stx.8.0-v1.5.9
.. |v_starlingx-stx-snmp| replace:: stx.8.0-v1.0.0
.. |v_starlingx-stx-vault-manager| replace:: stx.5.0-v1.18.3
.. |v_untergeek-curator| replace:: 5.7.6
.. |v_wind-river-cloud-platform-deployment-manager| replace:: WRCP_22.12
.. |v_wind-river-cmk| replace:: WRCP.20.01-v1.3.1-15-ge3df769-1
.. |v_wind-river-dm-monitor| replace:: WRCP_22.12-v1.0.0

6
doc/source/admintasks/kubernetes/oran-o2-application-b50a0c899e66.rst
View File

@ -234,7 +234,7 @@ You can install |O-RAN| O2 application on |prod| from the command line.
EOF
To deploy other versions of an image required for a quick solution, to
have early access to the features (eg. oranscinf/pti-o2imsdms:2.0.0), and
have early access to the features (eg. oranscinf/pti-o2imsdms:|v_oranscinf-pti-o2imsdms|), and
to authenticate images that are hosted by a private registry, follow the
steps below:
@ -250,7 +250,7 @@ You can install |O-RAN| O2 application on |prod| from the command line.
#. Refer to the ``imagePullSecrets`` in override file.
.. code-block:: bash
.. parsed-literal::
cat <<EOF > o2service-override.yaml
imagePullSecrets:
@ -260,7 +260,7 @@ You can install |O-RAN| O2 application on |prod| from the command line.
serviceaccountname: admin-oran-o2
images:
tags:
o2service: ${O2SERVICE_IMAGE_REG}/docker.io/oranscinf/pti-o2imsdms:2.0.0
o2service: ${O2SERVICE_IMAGE_REG}/docker.io/oranscinf/pti-o2imsdms:|v_oranscinf-pti-o2imsdms|
postgres: ${O2SERVICE_IMAGE_REG}/docker.io/library/postgres:9.6
redis: ${O2SERVICE_IMAGE_REG}/docker.io/library/redis:alpine
pullPolicy: IfNotPresent

4
doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst
View File

@ -41,7 +41,7 @@ subcloud, the subcloud installation has these phases:
.. _installing-a-subcloud-using-redfish-platform-management-service-ul-g5j-3f3-qjb:
- The docker **rvmc** image needs to be added to the System Controller
bootstrap override file, ``docker.io/starlingx/rvmc:stx.8.0-v1.0.1``.
bootstrap override file, docker.io/starlingx/rvmc:|v_starlingx-rvmc|.
- A new system CLI option ``--active`` is added to the
:command:`load-import` command to allow the import into the
@ -426,4 +426,4 @@ command with the ``install-values.yaml`` file containing the desired
- For more information on bootstrapping and deploying, see the procedures
listed under :ref:`install-a-subcloud`.

4
doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst
View File

@ -62,7 +62,7 @@ The config provided below is for illustrative purposes and is not validated.
A suitable user-supplied container would have to be run in the same pod and
configured to make API calls to the notificationclient-base container.
.. code-block:: none
.. parsed-literal::
apiVersion: apps/v1
kind: Deployment
@ -92,7 +92,7 @@ configured to make API calls to the notificationclient-base container.
- "true"
containers:
- name: ptp-notification-demo-sidecar
image: "starlingx/notificationclient-base:stx.8.0-v2.0.2"
image: "starlingx/notificationclient-base:|v_starlingx-notificationclient-base|"
imagePullPolicy: IfNotPresent
tty: true
stdin: true

4
doc/source/operations/ceph_cluster_aio_duplex_migration.rst
View File

@ -598,7 +598,7 @@ Apply rook-ceph application
#. Apply deployment mon-data-edit
::
.. parsed-literal::
mon-data-edit.yaml
apiVersion: apps/v1
@ -621,7 +621,7 @@ Apply rook-ceph application
dnsPolicy: ClusterFirstWithHostNet
containers:
- name: mon-data-edit
image: registry.local:9001/docker.io/rook/ceph:v1.2.7
image: registry.local:9001/docker.io/rook/ceph:|v_rook-ceph|
command: ["/tini"]
args: ["-g", "--", "/usr/local/bin/toolbox.sh"]
imagePullPolicy: IfNotPresent

15
doc/source/security/kubernetes/enable-public-use-of-the-cert-manager-acmesolver-image.rst
View File

@ -16,11 +16,11 @@ http01 challenge from the external CA.
As part of the application-apply of cert-manager at bootstrap time, the
cert-manager-acmesolver image has been pulled from an external registry and
pushed to
registry.local:9001:/quay.io/jetstack/cert-manager-acmesolver:<tag>.
registry.local:9001:/quay.io/jetstack/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver|.
However, this repository within registry.local is secured such that only
**admin** can access these images.
The registry.local:9001:/quay.io/jetstack/cert-manager-acmesolver:<tag>
The registry.local:9001:/quay.io/jetstack/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver|
image needs to be copied by **admin** into a public repository,
registry.local:9001:/public. If you have not yet set up a public
repository, see |admintasks-doc|: :ref:`Set up a Public Repository in Local Docker Registry
@ -34,18 +34,17 @@ repository, see |admintasks-doc|: :ref:`Set up a Public Repository in Local Dock
~(keystone_admin)]$ system registry-image-tags quay.io/jetstack/cert-manager-acmesolver
#. Copy the cert-manager-acmesolver image, and replace <TAG> with the tag
you want to copy from previous step.
#. Copy the cert-manager-acmesolver image.
.. code-block:: none
.. parsed-literal::
$ sudo docker login registry.local:9001
username: admin
password: <admin-password>
$
$ sudo docker pull registry.local:9001/quay.io/jetstack/cert-manager-acmesolver:<TAG>
$ sudo docker tag registry.local:9001/quay.io/jetstack/cert-manager-acmesolver:<TAG> registry.local:9001/public/cert-manager-acmesolver:<TAG>
$ sudo docker push registry.local:9001/public/cert-manager-acmesolver:<TAG>
$ sudo docker pull registry.local:9001/quay.io/jetstack/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver|
$ sudo docker tag registry.local:9001/quay.io/jetstack/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver| registry.local:9001/public/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver|
$ sudo docker push registry.local:9001/public/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver|
#. Update the cert-manager application to use this public image.

2
doc/source/security/kubernetes/enable-use-of-cert-manager-acmesolver-image-in-a-particular-namespace.rst
View File

@ -14,7 +14,7 @@ challenge from the external CA.
.. rubric:: |context|
In order to pull the
registry.local:9001:/public/cert-manager-acmesolver:<tag> image from the
registry.local:9001:/public/cert-manager-acmesolver:|v_jetstack-cert-manager-acmesolver| image from the
local registry, the credentials for the public repository must be in a
secret and referenced in an ImagePullSecret in the **default**
serviceAccount of that user-specified namespace.

4
doc/source/security/kubernetes/security-configure-container-backed-remote-clis-and-clients.rst
View File

@ -256,7 +256,7 @@ CLIs and Clients for an admin user with cluster-admin clusterrole.
.. parsed-literal::
$ ./configure_client.sh -t platform -r admin-openrc.sh -k admin-kubeconfig -w HOME/remote_cli_wd -p |registry-url|/starlingx/stx-platformclients:stx.8.0-v1.5.9
$ ./configure_client.sh -t platform -r admin-openrc.sh -k admin-kubeconfig -w HOME/remote_cli_wd -p |registry-url|/starlingx/stx-platformclients:|v_starlingx-stx-platformclients|
If you specify repositories that require authentication, as shown
above, you must first perform a :command:`docker login` to that
@ -311,7 +311,7 @@ CLIs and Clients for an admin user with cluster-admin clusterrole.
.. parsed-literal::
$ ./configure_client.sh -t platform -r admin-openrc.sh -k admin-kubeconfig -w $HOME/remote_cli_wd -p |registry-url|/starlingx/stx-platformclients:stx.8.0-v1.5.9
$ ./configure_client.sh -t platform -r admin-openrc.sh -k admin-kubeconfig -w $HOME/remote_cli_wd -p |registry-url|/starlingx/stx-platformclients:|v_starlingx-stx-platformclients|
If you specify repositories that require authentication, you must first
perform a :command:`docker login` to that repository before using

4
doc/source/system_configuration/kubernetes/check-new-registry-and-reapply-application.rst
View File

@ -61,10 +61,10 @@ to controller-1 and perform the same steps.
#. Then, debug tail ``-f /var/log/sysinv.log`` and look for the following information:
.. code-block:: none
.. parsed-literal::
sysinv 2020-09-09 23:42:23.476 14930 INFO sysinv.conductor.kube_app [-] Image registry.local:9001/quay.io/kubernetes-ingress-controller/nginx-ingress-controller:0.23.0 is not available in local registry, download started from public/private registry
sysinv 2020-09-09 23:42:23.526 14930 INFO sysinv.conductor.kube_app [-] Image registry.local:9001/k8s.gcr.io/defaultbackend:1.4 download succeeded in 0 seconds
sysinv 2020-09-09 23:42:23.526 14930 INFO sysinv.conductor.kube_app [-] Image registry.local:9001/k8s.gcr.io/defaultbackend:|v_defaultbackend| download succeeded in 0 seconds
sysinv 2020-09-09 23:43:10.226 14930 INFO sysinv.conductor.kube_app [-] Remove image <hostname>:5001/<quay.io path>/quay.io/kubernetes-ingress-controller/nginx-ingress-controller:0.23.0 after push to local registry.
sysinv 2020-09-09 23:43:10.595 14930 INFO sysinv.conductor.kube_app [-] Image registry.local:9001/quay.io/kubernetes-ingress-controller/nginx-ingress-controller:0.23.0 download succeeded in 47 seconds
sysinv 2020-09-09 23:43:10.596 14930 INFO sysinv.conductor.kube_app [-] All docker images for application nginx-ingress-controller were successfully downloaded in 50 seconds

2
doc/source/usertasks/kubernetes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rst
View File

@ -192,7 +192,7 @@ and clients for a non-admin user.
.. parsed-literal::
$ ./configure_client.sh -t platform -r my-openrc.sh -k user-kubeconfig -w $HOME/remote_cli_wd -p |registry-url|/starlingx/stx-platformclients:stx.8.0-v1.5.9
$ ./configure_client.sh -t platform -r my-openrc.sh -k user-kubeconfig -w $HOME/remote_cli_wd -p |registry-url|/starlingx/stx-platformclients:|v_starlingx-stx-platformclients|
If you specify repositories that require authentication, you must
perform a :command:`docker login` to that repository before using

12
doc/source/usertasks/kubernetes/vran-tools-2c3ee49f4b0b.rst
View File

@ -5,7 +5,7 @@ vRAN Tools
==========
The |vRAN| tools consist of the following open-source packages that are delivered
in the container image ``starlingx/stx-debian-tools-dev:stx.8.0-v1.0.3``. For more
in the container image starlingx/stx-debian-tools-dev:|v_starlingx-stx-debian-tools-dev|. For more
detailed information on the tools packages, click the hyperlink on the
package names, which will lead you to the Debian Bullseye package information
web page https://packages.debian.org/bullseye/<package name>.
@ -52,7 +52,7 @@ on resources in the host context.
The suggested yaml manifest to launch the ``stx-debian-tools-dev`` container is
as follows:
.. code-block:: none
.. parsed-literal::
# Creating the Kubernetes Deployment
cat << EOF > stx-debian-tools-dev.yaml
@ -72,7 +72,7 @@ as follows:
spec:
containers:
- name: stx-debian-tools-dev
image: docker.io/starlingx/stx-debian-tools-dev:stx.8.0-v1.0.3
image: docker.io/starlingx/stx-debian-tools-dev:|v_starlingx-stx-debian-tools-dev|
imagePullPolicy: Always
stdin: true
tty: true
@ -126,7 +126,7 @@ Then ``exec`` into shell in container:
Build, deploy and run non-open-source tools
-------------------------------------------
The ``starlingx/stx-debian-tools-dev:stx.8.0-v1.0.3`` container image also
The starlingx/stx-debian-tools-dev:|v_starlingx-stx-debian-tools-dev| container image also
contains development tools.
Using this container image as a Dockerfile base image enables |prod| users to
@ -143,11 +143,11 @@ you need access.
You can create and build a container to run Quartzville tools on Kubernetes as
follows:
.. code-block:: none
.. parsed-literal::
# Creating the Dockerfile
cat << EOF > Dockerfile
FROM docker.io/starlingx/stx-debian-tools-dev:stx.8.0-v1.0.3
FROM docker.io/starlingx/stx-debian-tools-dev:|v_starlingx-stx-debian-tools-dev|
USER root
WORKDIR /root