diff --git a/doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst b/doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst index d5540a1fd..153d064b7 100644 --- a/doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst +++ b/doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst @@ -29,7 +29,7 @@ In order to enable and configure |SNMP|, complete the following steps. #. Use the following command to list the system applications and check whether |SNMP| is uploaded or applied. If |SNMP| is already "uploaded", go to Step 5 to configure and enable |SNMP|. If |SNMP| is already "applied", |SNMP| is - already configured and enabled, see, :ref:`Change Configuration of the SNMP + already configured and enabled, see :ref:`Change Configuration of the SNMP application ` to make configuration changes. .. code-block:: none @@ -47,8 +47,8 @@ In order to enable and configure |SNMP|, complete the following steps. #. In order to load the |SNMP| application definitions (FluxCD manifest and Helm charts), where **[snmp-.-.tgz]**, for example, - **snmp-1.0-2.tgz** is the app filename, with version **1.0-2**, available - at the following path "/usr/local/share/applications/helm", use the + **snmp-1.0-2.tgz** is the app filename with version **1.0-2** available + at the following path ``/usr/local/share/applications/helm`` use the following command. .. code-block:: none @@ -92,7 +92,7 @@ In order to enable and configure |SNMP|, complete the following steps. variable in the |SNMP| Helm chart is a multi-line variable that follows the syntax of Net-SNMP's ``snmpd.conf`` file for configuring the |SNMP| agent, see `http://www.net-snmp.org/docs/man/snmpd.conf.html - `__, for a detailed + `__, for detailed description of the commands. .. warning:: @@ -127,10 +127,10 @@ In order to enable and configure |SNMP|, complete the following steps. trapsess -v 3 -u testuser -a MD5 -A testpassword -l authPriv -x DES -X testpassword udp:10.10.10.1:162 EOF - **\(Optional\)** You can add your own EngineID value, instead of having it + **(Optional)** You can add your own EngineID value, instead of having it auto-created. This keeps the EngineID value the same, even when the |SNMP| application restarts. The EngineID is required if you are using an |SNMP| - trap viewer or |SNMP| monitoring tool. Add the 'engineID [STRING]' value in + trap viewer or |SNMP| monitoring tool. Add the `engineID [STRING]` value in the ``configmap:user_conf`` variable, as shown below. .. code-block:: none @@ -143,6 +143,24 @@ In order to enable and configure |SNMP|, complete the following steps. ... EOF + .. note:: + + The EngineID value consists of a string of 10-64 characters in + hexadecimal numbers. In case you need to specify the + whole string (i.e., Net-SNMP will not add characters), you can use the + ``exactEngineID`` value instead. Add the `exactEngineID 0X[STRING]` + value in the ``configmap:user_conf`` variable, as shown below. + + .. code-block:: none + + cat < user_conf.yaml + configmap: + user_conf: |- + ... + exactEngineID 0X[STRING] + ... + EOF + #. Update the values of the ``configmap:user_conf`` attribute on the Helm chart using the following command. @@ -309,9 +327,9 @@ update its configuration. .. rubric:: |proc| #. Create a Helm chart values file (for example, user_conf.yaml) with the - definition of the **configmap:user_conf** attribute defining your SNMP + definition of the ``configmap:user_conf`` attribute defining your SNMP configuration of V2 communities, V2 trap sinks, V3 users and/or V3 trap - sessions, as shown in the example below. The **configmap:user_conf** + sessions, as shown in the example below. The ``configmap:user_conf`` variable in the SNMP Helm chart is a multi-line variable that follows the syntax of Net-SNMP's snmpd.conf file for configuring the SNMP agent, see `http://www.net-snmp.org/docs/man/snmpd.conf.html `__, @@ -349,11 +367,11 @@ update its configuration. trapsess -v 3 -u testuser -a MD5 -A testpassword -l authPriv -x DES -X testpassword udp:10.10.10.1:162 EOF - **\(Optional\)** You can add your own EngineID value, instead of having it + **(Optional)** You can add your own EngineID value, instead of having it auto-created. This keeps the EngineID value the same, even when the |SNMP| application restarts. The EngineID is required if you are using an |SNMP| - trap viewer or |SNMP| monitoring tool. Add the 'engineID [STRING]' value in - the`` configmap:user_conf`` variable, as shown below. + trap viewer or |SNMP| monitoring tool. Add the `engineID [STRING]` value in + the ``configmap:user_conf`` variable, as shown below. .. code-block:: none @@ -365,6 +383,24 @@ update its configuration. ... EOF + .. note:: + + The EngineID value consists of a string of 10-64 characters in + hexadecimal numbers. In this case you need to specify the + whole string (i.e., Net-SNMP will not add characters), you can use the + ``exactEngineID`` value instead. Add the `exactEngineID 0X[STRING]` + value in the ``configmap:user_conf`` variable, as shown below. + + .. code-block:: none + + cat < user_conf.yaml + configmap: + user_conf: |- + ... + exactEngineID 0X[STRING] + ... + EOF + #. Update the values of the ``configmap:user_conf`` attribute on the Helm chart using the following command. diff --git a/doc/source/spelling_wordlist.txt b/doc/source/spelling_wordlist.txt index 3918b6776..02954c611 100644 --- a/doc/source/spelling_wordlist.txt +++ b/doc/source/spelling_wordlist.txt @@ -847,7 +847,7 @@ runtimes rvmc rw rx -µs +µs Salesforce sampleimage sbin @@ -1166,3 +1166,1176 @@ yml yums zoneinfo zuul +======= +<<<<<<< HEAD (6d1c1e Merge "Fix errors in the proc. to config. HTTPS and use remo) +======= +acc +accessMode +acdf +acmesolver +addon +addrpool +ae +af +afb +affine +affined +affining +aio +AIO +Akraino +AlarmID +AlarmSeverity +alloc +allowMultiplePerNode +amazonaws +amd +analytical +analytics +Analytics +ansible +Ansible +aodh +Aodh +api +apiGroups +apis +apiserver +apparmor +appname +args +ata +atch +attrs +auditable +auditd +Auditd +auth +authNoPriv +authPriv +autoboot +autoscale +autoscaler +Autoscaler +autoscaling +autounseal +awk +ba +backend +Backend +backends +Backends +backendType +backported +balancer +barbican +Barbican +baseband +bc +benchmarked +benchmarking +bgp +billingDeptGroup +bindDN +bindep +bindPW +binutils +bitbake +Bitbake +bitstream +blkin +blockchain +bmc +boolean +bootable +Bootable +bootarg +bootargs +bootimage +bootloader +Broadcom +Broadwell +bulleted +Bullseye +burstable +Burstable +busybox +CaaS +caCert +cainjector +calc +cancelled +cbf +cd +cdfa +cea +cec +Celo +cengn +centos +ceph +Ceph +cephcsi +cephfs +cephx +certgen +certifcate +certtype +cfg +cgcs +cgroup +cgroups +cgts +checkbox +checksum +chipset +chrony +chronyd +cli +CLI +Cloudification +clusterissuer +clusterrole +cmdline +cmk +CN +cni +codebase +coldStart +Coleto +collectd +Columbiaville +commandline +committer +conf +config +Config +configmap +configmaps +configs +confluentinc +ConnectX +consumergroup +containerd +Containerd +controllermanager +controllerstorage +coredns +Coredns +coredump +Coredump +coreos +CoW +cp +cpio +cpu +cpuinfo +cpus +cpuset +cpuX +cqn +cri +crit +cron +cronjob +cronSchedule +crt +crushmap +crypto +cryptographic +cryptographically +csi +csr +ctl +customizable +Customizable +customizations +cutover +cyber +cyclictest +Cygwin +dacyclictest +daea +daemonset +daemonsets +Daemonsets +datafile +datanet +datanetwork +datanetworks +datanetworkUUID +DateAndTime +dave +dbdad +dbmon +dcdbsync +dcmanager +dcorch +dea +deallocate +Deallocate +Declaratively +decrypt +dedicatedstorage +defaultbackend +deployer +deprovision +Deprovision +deprovisioned +deprovisioning +dev +Dev +devtoolset +dex +Dex +df +dfc +dhcp +dialogs +dimensioned +dimensioning +Dimensioning +dir +dirs +diskio +diskspace +distcloud +distro +Distro +distros +Djava +dkr +DL +dmesg +dns +dnsmasq +dockerfile +Dockerfile +domainNumber +dpdk +dpdkBasebandDevice +dracut +DRBD +dropbox +dropdown +dynticks +eASIC +eb +ebtables +ecr +edgeworker +Edgeworker +Edgeworkers +EF +efi +EFI +eHTML +elasticsearch +Elasticsearch +electomechanical +elfutils +elipse +emerg +Emulex +enablement +Enablement +engineID +exactEngineID +enp +EntityInstanceID +env +esJavaOpts +etcd +Etcd +EtcdCA +EtcdRootCA +etf +eth +ethernet +EventID +EventSeverity +EventType +executables +eXtensible +faa +fac +facto +failover +failsafe +fb +fc +fcae +fcd +fd +fec +fieldname +filebeat +Filebeat +filename +fileName +filepath +filestore +filesystem +Filesystem +filesystems +Filesystems +finalizers +flexvol +fluxcd +Fortville +foundational +fpga +fqdn +Freerun +frontend +fs +fsid +fsstat +fsync +fullnameOverride +functionalities +fw +gapped +Gb +GbE +Gbps +Gbs +GBytes +gcr +getaffinity +ghcr +GiB +github +globalnetworkpolicy +gnp +golang +google +gpt +gPTP +gpu +grpc +gRPC +grubx +guestmount +guestunmount +gui +hardcode +hardcoded +hashicorp +Haswell +HDD +helmv +hexidecimal +hieradata +hostname +Hostname +hostnames +hostwd +hpa +http +Http +https +hugepage +hugepages +Hugepages +hw +hyperthreading +Hyperthreading +hyperthreads +hypervisor +hypervisors +IaaS +iavf +icmp +icr +IDE +IDentity +idisk +iDRAC +ifclass +ifname +igb +IIoT +iLO +ima +ImagePolicy +imagePullPolicy +imagePullSecret +implantisomd +indeterministic +init +initramfs +initrd +inprogress +instantiation +insync +integ +intel +intermediateCA +intnet +io +iodepth +ioengine +iops +iostat +IoT +iov +iowait +ip +ipam +iperf +iproute +iptables +IPv +ipVersion +Ipvlan +iPXE +irq +isGateway +iso +isohybrid +isolcpus +istio +Istiod +javascript +jbod +jetstack +jettech +jitter +jmx +josdotso +journaling +jsmith +kafka +kata +Kata +Kbps +keypairs +keyring +keystoneUserName +kiali +KiB +kibana +Kibana +kickstart +kmem +Kontron +kuard +kube +kubeadm +kubebuilder +kubeconfig +kubectl +kubelet +kubelets +Kubelets +kubernetes +Kubernetes +kubesystem +kustomize +kvm +kworker +labelled +labelling +latencies +libaio +libbeat +libbpf +libnet +libnetwork +Libnetwork +libpcap +libseccomp +libteam +libvirt +lifecycle +Lifecycle +linreg +linters +linux +linuxptp +liveness +Liveness +lldpd +loadbuild +localdisk +localhost +localrc +login +logins +Logins +logout +logrotate +logstash +Logstash +logstashJavaOpts +logSyncInterval +logtash +loopback +losetup +lowlat +lowlatency +lst +lv +lvm +lvmthinpool +lwolf +Maclaren +macOS +Macvlan +makefile +managerGroup +mariadb +Mariadb +Mbps +md +Mellanox +mem +memcached +Memcached +memstats +metadata +Metadata +metricbeat +Metricbeat +metricset +metricsets +Metricsets +mgmt +Mgmt +mib +MiB +Millicores +mins +mitigations +mkisofs +mktemp +mnfa +mnt +mockchain +mon +monmap +mons +monstore +motd +mountpoint +mqprio +mS +msec +mtcAgent +mtu +multi +Multi +multicast +Multicast +multichassis +multus +myApplication +mycompany +mydomain +nameservers +namespace +Namespace +namespaced +namespaces +Namespaces +nanosleep +ncat +neighbour +netapp +Netapp +Netapps +netboot +netdevice +netmask +nEtw +Netw +networktype +newnote +nfd +nfs +nfv +nginx +Nginx +Niantic +NIC +nmap +nn +NodePort +nodeSelector +novncproxy +ns +ntfs +ntp +ntpd +ntpservers +num +Num +numa +numjobs +numvfs +nvidia +NVM +nvme +oam +OAM +observability +OCI +offbox +oidc +Oidc +ok +onboard +Onboard +onbox +oneAPI +onwards +opendev +openflow +Openflow +openLDAP +openrc +opensource +Openssh +openssl +openstack +Openstack +openstackclients +optimizations +Optimizations +orchestrator +Orchestrator +osd +oss +ostree +overcommitted +overrideable +ovs +ovverrides +panko +Panko +params +Paravirtualized +parition +passhtru +passthrough +Passthrough +passthru +passwd +pci +PCI +pciaddress +pcm +pcnet +PCnet +peergroup +pem +perf +persistentvolume +persistentVolumeClaims +pgp +pgs +phc +pids +pkgs +Pkgs +pki +platformclients +playbookconfig +pmon +pmond +pnet +podAntiAffinity +popup +portieris +Portieris +portState +postgres +Postgres +Postgresql +postrequisites +Postrequisites +poweroff +Powerville +pre +Pre +prebuilt +preconfigured +preemptibility +preemptible +preferIPv +prepended +prepends +prestage +Prestage +prestaged +Prestaged +Prestages +prestaging +Prestaging +prestart +priv +ProbableCause +proc +processname +project +prometheus +ProposedRepairAction +proto +Proto +providernet +provisioner +provisioners +pseudocode +psp +ptp +ptptracking +purposes +pv +pvc +pxe +pxeboot +Pxeboot +pxebooting +pxelinux +py +qat +Qav +Qbv +qcow +qdisc +qdiscs +qemu +qos +QoS +Quartzville +querier +Quickstart +rabbitmq +Rabbitmq +rados +Rados +ramdisk +ramptime +randrepeat +randwrite +rbac +rbd +rc +rclka +rclkb +rdparties +readded +README +readonly +readOnlyRootFilesystem +Realtek +realtime +ReasonText +rebalance +rebase +reconfig +reconfiguring +Redfish +redirectURIs +redis +reenabled +regex +rehome +Rehome +rehomed +rehoming +Rehoming +reinstall +reinstallation +Reinstallation +reinstallations +reinstalled +reinstalling +Rendevous +reno +replicaCount +replicaset +replicaSet +replicaSets +ReplicaSets +repo +Repo +REPO +repos +reprovision +reprovisioning +repulled +reselect +reselection +resizable +resize +resized +resizer +resizing +Resizing +resourceName +restapi +restartable +reStructuredText +resynchronization +Resynchronize +retestneeded +retimer +Retimer +rgw +rk +RK +rmdir +rms +ro +rolebindings +RoleBindings +rollout +rom +rookstorage +rootca +rootfs +Rootfs +rootkey +rpc +rpmbuild +rpms +rss +rst +rST +rsync +rsyncd +rtl +runAsNonRoot +runc +runlevel +runlevels +runnable +runqueue +runtime +Runtime +runtimes +rvmc +rw +rx +�s +Salesforce +sampleimage +sbin +scalability +Scalability +scalable +sched +schemas +scsi +sda +sdb +sdc +searchable +secureboot +securityConfig +securityFiles +sed +selectwhich +sensorname +seperated +serviceaccount +serviceAccount +serviceaccounts +serviceAccounts +ServiceAffecting +severities +Shaper +sig +Skylake +sma +sma1 +sma2 +snapshotter +snetworkplumbingwg +snmp +SNMP +snmpd +softirq +solsson +sortable +specfile +spectre +Spectre +Springville +src +Src +sriov +sRootCA +srpm +srpms +SSD +ssl +stackanetes +starlingx +Starlingx +StarlingX +startup +statefulset +staticClients +stdout +storageclasses +storages +stx +Stx +STX +subagent +subcloud +Subcloud +subclouds +Subclouds +subcommand +subcommands +Subcommands +subdirectory +subfunctions +subgit +subinterface +subnet +Subnet +subnetpool +subnets +Subnets +subPath +sudo +sudoers +SuppressionAllowed +svc +sw +swact +Swact +Swacted +swacting +Swacting +Swacts +switchover +switchovers +SX +Symkloud +symlink +symlinks +synce +syncE +SyncE +synching +sys +syscall +sysctls +sysinv +Sysinv +syslog +systemController +systemctl +systemd +Systemd +taprio +taskbar +tcp +tcpdump +telecom +templated +templating +testmac +testuser +tftp +tftpboot +tgz +Thr +throughputs +tiering +tiername +timelines +timestamp +timestamping +timeTraceable +tls +TLS +tmp +toml +topologies +touchless +tox +traceability +tradeoffs +triaged +Triaged +triages +triaging +trustServer +TSN +tty +tunable +tx +Tx +txt +ubuntu +udisksctl +udp +uds +uio +umount +unallocated +uncommented +unconfigured +Uncore +unicast +Unicast +unicasted +unixPermissions +Unmanage +unmanaged +Unmanaged +unmanaging +Unmount +unmounting +Unpause +unreferenced +unremovable +unselected +unsuppress +Unsuppress +unsuppressed +unsuppressing +untagged +Untar +untergeek +untrusted +uptime +upversion +Upversion +upversioned +uri +url +Url +urls +uS +usec +useradd +userid +username +Username +userspace +usr +Ussuri +uuid +valgrind +varbind +varbinds +vCPU +vCPUs +vdi +Venafi +vepa +versioned +versioning +veth +vf +vfio +Vfio +vfor +vg +vGPU +vhost +Vhost +Vid +Vids +virsh +virt +virtio +Virtio +virtualization +Virtualization +virtualized +vlan +Vlan +vNIC +vNICs +volumeClaimTemplate +volumegroup +volumev +vPC +vRAN +vswitch +vSwitch +VTx +vxlan +wadcert +wakeup +wal +warmStart +wd +webhook +Webhook +webserver +Webserver +Westport +wget +wildcard +wildcards +windriver +winpty +wipedisk +workflow +Workflow +workflows +workqueue +Workqueue +workspace +wr +WRCP +wrlinux +wrs +wrsAlarmActiveAlarmId +wrsAlarmActiveAlarmID +wrsAlarmActiveAlarmSeverity +wrsAlarmActiveDateAndTime +wrsAlarmActiveEntityInstanceId +wrsAlarmActiveEntityInstanceID +wrsAlarmActiveEventType +wrsAlarmActiveProbableCause +wrsAlarmActiveProposedRepairAction +wrsAlarmActiveReasonText +wrsAlarmActiveServiceAffecting +wrsAlarmActiveSuppressionAllowed +wrsAlarmActiveUuid +wrsAlarmClear +wrsAlarmCritical +wrsAlarmHierarchicalClear +wrsAlarmMajor +wrsAlarmMessage +wrsAlarmMinor +wrsAlarmWarning +wrsCommon +wrsEventDateAndTime +wrsEventEntityInstanceId +wrsEventEventId +wrsEventEventType +wrsEventProbableCause +wrsEventProposedRepairAction +wrsEventReasonText +wrsEventServiceAffecting +wrsEventSeverity +wrsEventState +wrsEventSuppressionAllowed +wrsEventUuid +www +xcc +xd +Xeon +xmit +xml +Xms +Xmx +XOR'd +yaml +yml +yums +zoneinfo +zuul +