From 232476219e69afc14647892250bba08a3118a7e7 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 14 Apr 2011 09:22:26 -0500 Subject: doc: Fix some documentation issues (#980) Signed-off-by: Sol Jerome --- doc/help/troubleshooting.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index 17bc391bd..e593db2f7 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -145,6 +145,10 @@ be taken to remedy them. | | | character present | | | | | in this file. | | +------------------------------+----------+---------------------+--------------+ +| Got unknown entries | Server | The Packages plugin | [11]_ | +| [list of unknown entries] | | has no knowledge of | | +| | | the listed entries | | ++------------------------------+----------+---------------------+--------------+ .. [1] This entry is not being bound. Ensure that a version of this @@ -166,6 +170,14 @@ be taken to remedy them. group is properly setup. .. [10] Ensure the correct encoding is specified in the [components] section of ``bcfg2.conf``. +.. [11] For packages listed other than **gpg-pubkey**, this error means + that the Packages plugin is unable to find the package in any of + the sources listed in ``Packages/config.xml``. The issue often + arises when the client is not in one of the groups necessary for + the Source listed. In the case of gpg-pubkey, you can safely + ignore the message as the Packages plugin has no knowledge of + these packages (however, note that this package is most often + specified as a BoundPackage entry). FAQs ==== -- cgit v1.2.3-1-g7c22 From 6da7d24710fe67c80c4a71f227cd01675eebca88 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 21 Apr 2011 08:50:06 -0400 Subject: Lots of cleanup for bcfg2-repo-validate rewrite: * Changed all references to bcfg2-repo-validate in the documentation to bcfg2-lint * Wrote man pages for bcfg2-lint and bcfg2-lint.conf * Cleaned up straggling references to bcfg2-repo-validate in Makefiles, spec files, and the POSIX tool * A few minor bug fixes --- doc/help/troubleshooting.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index e593db2f7..033b60706 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -38,9 +38,8 @@ Check if all repository XML files conform to schemas ==================================================== Bcfg2 comes with XML schemas describing all of the XML formats used in -the server repository. A validation command ``bcfg2-repo-validate`` is -included with the source distribution and all packages. Run it with the --v flag to see each file and the results if its validation. +the server repository. A validation command ``bcfg2-lint`` is +included with the source distribution and all packages. If the bcfg2 server is not reflecting recent changes, try restarting the bcfg2-server process ============================================================================================= -- cgit v1.2.3-1-g7c22 From 608fb57dd36053eb252d188ea7ba2c0a80a5631f Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 23 Apr 2011 20:08:59 -0500 Subject: doc: Clarify troubleshooting techniques Signed-off-by: Sol Jerome --- doc/help/troubleshooting.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index 033b60706..d758ca7a5 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -152,7 +152,9 @@ be taken to remedy them. .. [1] This entry is not being bound. Ensure that a version of this entry applies to this client. -.. [2] Add a type to the generator definition for this entry +.. [2] It is possible that the type attribute for this generator entry + is undefined. You may need to add the appropriate type attribute + in the literal entry specification. .. [3] Copy the Bcfg2 server's CA certificate to the client and specify it using the **ca** option in the [communication] section of ``bcfg2.conf`` -- cgit v1.2.3-1-g7c22 From b6c9928eced9b725d936260d003026f1ebfa455d Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 5 May 2011 11:10:29 -0500 Subject: Core: Raise error on failed lxml import (Reported by Raul Cuza on IRC) Signed-off-by: Sol Jerome --- doc/help/troubleshooting.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index d758ca7a5..88a0febc5 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -148,6 +148,10 @@ be taken to remedy them. | [list of unknown entries] | | has no knowledge of | | | | | the listed entries | | +------------------------------+----------+---------------------+--------------+ +| Failed to import lxml | Server | The server cannot | [12]_ | +| dependency. Shutting | | import lxml | | +| down server. | | | | ++------------------------------+----------+---------------------+--------------+ .. [1] This entry is not being bound. Ensure that a version of this @@ -179,6 +183,8 @@ be taken to remedy them. ignore the message as the Packages plugin has no knowledge of these packages (however, note that this package is most often specified as a BoundPackage entry). +.. [12] Ensure that you have installed all the necessary + :ref:`installation-prerequisites`. FAQs ==== -- cgit v1.2.3-1-g7c22 From b808e63f6ea6c872503a648eec33cadaa512cc34 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 25 May 2011 22:19:40 -0500 Subject: POSIX: Clarify normalization error (Reported by Tim Goodaire) Signed-off-by: Sol Jerome --- doc/help/troubleshooting.txt | 54 ++++++++++++++++++++++++++++---------------- 1 file changed, 35 insertions(+), 19 deletions(-) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index 88a0febc5..010c80de5 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -109,46 +109,56 @@ be taken to remedy them. | authenticate the server with | | unable to verify | | | SSL. | | the server | | +------------------------------+----------+---------------------+--------------+ -| Failed to bind entry: | Server | The server was | [4]_ | +| GID normalization failed for | Client | The client is | [4]_ | +| FILENAME. Does group GROUP | | unable to convert | | +| exist? | | the group GROUP to | | +| | | a usable GID | | ++------------------------------+----------+---------------------+--------------+ +| UID normalization failed for | Client | The client is | [5]_ | +| FILENAME. Does owner OWNER | | unable to convert | | +| exist? | | the owner OWNER to | | +| | | a usable UID | | ++------------------------------+----------+---------------------+--------------+ +| Failed to bind entry: | Server | The server was | [6]_ | | | | unable to find a | | | | | suitable version of | | | | | entry for client. | | +------------------------------+----------+---------------------+--------------+ -| Failed to bind to socket | Server | The server was | [5]_ | +| Failed to bind to socket | Server | The server was | [7]_ | | | | unable to bind to | | | | | the tcp server | | | | | socket. | | +------------------------------+----------+---------------------+--------------+ -| Failed to load | Server | The server was | [6]_ | +| Failed to load | Server | The server was | [8]_ | | ssl key | | unable to read and | | | | | process the ssl key.| | +------------------------------+----------+---------------------+--------------+ -| Failed to read file | Server | The server failed | [7]_ | +| Failed to read file | Server | The server failed | [9]_ | | | | to read the | | | | | specified file | | +------------------------------+----------+---------------------+--------------+ -| Failed to parse file | Server | The server failed | [8]_ | +| Failed to parse file | Server | The server failed | [10]_ | | | | to parse the | | | | | specified XML file | | +------------------------------+----------+---------------------+--------------+ -| Client metadata resolution | Server | The server cannot | [9]_ | +| Client metadata resolution | Server | The server cannot | [11]_ | | error for | | resolve the client | | | | | hostname or the | | | | | client is | | | | | associated with a | | | | | non-profile group. | | +------------------------------+----------+---------------------+--------------+ -| Failed to decode | Server | The encoding being | [10]_ | +| Failed to decode | Server | The encoding being | [12]_ | | Please verify you are using | | used is unable to | | | the proper encoding | | decode the | | | | | character present | | | | | in this file. | | +------------------------------+----------+---------------------+--------------+ -| Got unknown entries | Server | The Packages plugin | [11]_ | +| Got unknown entries | Server | The Packages plugin | [13]_ | | [list of unknown entries] | | has no knowledge of | | | | | the listed entries | | +------------------------------+----------+---------------------+--------------+ -| Failed to import lxml | Server | The server cannot | [12]_ | +| Failed to import lxml | Server | The server cannot | [14]_ | | dependency. Shutting | | import lxml | | | down server. | | | | +------------------------------+----------+---------------------+--------------+ @@ -162,20 +172,26 @@ be taken to remedy them. .. [3] Copy the Bcfg2 server's CA certificate to the client and specify it using the **ca** option in the [communication] section of ``bcfg2.conf`` -.. [4] This entry is not being bound. Ensure that a version of this +.. [4] If the group doesn't exist, you need to specify the correct one + in an :ref:`info.xml ` file or set the default group + appropriately. +.. [5] If the owner doesn't exist, you need to specify the correct one + in an :ref:`info.xml ` file or set the default owner + appropriately. +.. [6] This entry is not being bound. Ensure that a version of this entry applies to this client. -.. [5] Ensure that another instance of the daemon (or any other process) +.. [7] Ensure that another instance of the daemon (or any other process) is not listening on the same port. -.. [6] Ensure that the key is readable by the user running the daemon +.. [8] Ensure that the key is readable by the user running the daemon and that it is well-formed. -.. [7] Ensure that this file still exists; a frequent cause is the +.. [9] Ensure that this file still exists; a frequent cause is the deletion of a temp file. -.. [8] Ensure that the file is properly formed XML. -.. [9] Fix hostname resolution for the client or ensure that the profile - group is properly setup. -.. [10] Ensure the correct encoding is specified in the [components] +.. [10] Ensure that the file is properly formed XML. +.. [11] Fix hostname resolution for the client or ensure that the profile + group is properly setup. +.. [12] Ensure the correct encoding is specified in the [components] section of ``bcfg2.conf``. -.. [11] For packages listed other than **gpg-pubkey**, this error means +.. [13] For packages listed other than **gpg-pubkey**, this error means that the Packages plugin is unable to find the package in any of the sources listed in ``Packages/config.xml``. The issue often arises when the client is not in one of the groups necessary for @@ -183,7 +199,7 @@ be taken to remedy them. ignore the message as the Packages plugin has no knowledge of these packages (however, note that this package is most often specified as a BoundPackage entry). -.. [12] Ensure that you have installed all the necessary +.. [14] Ensure that you have installed all the necessary :ref:`installation-prerequisites`. FAQs -- cgit v1.2.3-1-g7c22 From 1c10760466c83131a60b36a284c38c44ff4b73b8 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Tue, 31 May 2011 10:36:15 -0500 Subject: Cfg: Fix traceback for non-ascii files Signed-off-by: Sol Jerome --- doc/help/troubleshooting.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index 010c80de5..ecf53527c 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -162,6 +162,10 @@ be taken to remedy them. | dependency. Shutting | | import lxml | | | down server. | | | | +------------------------------+----------+---------------------+--------------+ +| You need to specify base64 | Server | The server cannot | [15]_ | +| encoding for | | send the file as | | +| | | ascii text | | ++------------------------------+----------+---------------------+--------------+ .. [1] This entry is not being bound. Ensure that a version of this @@ -201,6 +205,8 @@ be taken to remedy them. specified as a BoundPackage entry). .. [14] Ensure that you have installed all the necessary :ref:`installation-prerequisites`. +.. [15] You likely need to specify a base64 encoding using an + :ref:`server-info` file for this entry. FAQs ==== -- cgit v1.2.3-1-g7c22 From 95797b788dc180b240e0c1c17f2559fbb4600b5b Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Mon, 6 Jun 2011 12:36:56 -0500 Subject: Validate: Create and use new error type for missing schemas Signed-off-by: Sol Jerome --- doc/help/troubleshooting.txt | 110 +++++++++++++++++++++++++------------------ 1 file changed, 64 insertions(+), 46 deletions(-) (limited to 'doc/help/troubleshooting.txt') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index ecf53527c..5fe1500f4 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -81,121 +81,138 @@ Type `help` in bcfg2-info for more information. Error Messages ============== -This page describes error messages produced by Bcfg2 and steps that can +The tables below describe error messages produced by Bcfg2 and steps that can be taken to remedy them. +Client Errors +------------- + +------------------------------+----------+---------------------+--------------+ | Error | Location | Meaning | Repair | +==============================+==========+=====================+==============+ -| Incomplete information for | Client | The described entry | [1]_ | +| Incomplete information for | Client | The described entry | [c1]_ | | entry : | | is not fully | | | cannot verify | | specified by the | | | | | server, so no | | | | | verification can be | | | | | performed. | | +------------------------------+----------+---------------------+--------------+ -| Incomplete information for | Client | The described entry | [1]_ | +| Incomplete information for | Client | The described entry | [c1]_ | | entry : | | is not fully | | | cannot install | | specified by the | | | | | server, so no | | | | | verification can be | | | | | performed. | | +------------------------------+----------+---------------------+--------------+ -| The following entries are | Client | The client cannot | [2]_ | +| The following entries are | Client | The client cannot | [c2]_ | | not handled by any tool: | | figure out how to | | | : | | handle this entry. | | +------------------------------+----------+---------------------+--------------+ -| No ca is specified. Cannot | Client | The client is | [3]_ | +| No ca is specified. Cannot | Client | The client is | [c3]_ | | authenticate the server with | | unable to verify | | | SSL. | | the server | | +------------------------------+----------+---------------------+--------------+ -| GID normalization failed for | Client | The client is | [4]_ | +| GID normalization failed for | Client | The client is | [c4]_ | | FILENAME. Does group GROUP | | unable to convert | | | exist? | | the group GROUP to | | | | | a usable GID | | +------------------------------+----------+---------------------+--------------+ -| UID normalization failed for | Client | The client is | [5]_ | +| UID normalization failed for | Client | The client is | [c5]_ | | FILENAME. Does owner OWNER | | unable to convert | | | exist? | | the owner OWNER to | | | | | a usable UID | | +------------------------------+----------+---------------------+--------------+ -| Failed to bind entry: | Server | The server was | [6]_ | + + +.. [c1] This entry is not being bound. Ensure that a version of this + entry applies to this client. +.. [c2] It is possible that the type attribute for this generator entry + is undefined. You may need to add the appropriate type attribute + in the literal entry specification. +.. [c3] Copy the Bcfg2 server's CA certificate to the client and specify it + using the **ca** option in the [communication] section of + ``bcfg2.conf`` +.. [c4] If the group doesn't exist, you need to specify the correct one + in an :ref:`info.xml ` file or set the default group + appropriately. +.. [c5] If the owner doesn't exist, you need to specify the correct one + in an :ref:`info.xml ` file or set the default owner + appropriately. + +Server Errors +------------- + ++------------------------------+----------+---------------------+--------------+ +| Error | Location | Meaning | Repair | ++==============================+==========+=====================+==============+ +| Failed to bind entry: | Server | The server was | [s1]_ | | | | unable to find a | | | | | suitable version of | | | | | entry for client. | | +------------------------------+----------+---------------------+--------------+ -| Failed to bind to socket | Server | The server was | [7]_ | +| Failed to bind to socket | Server | The server was | [s2]_ | | | | unable to bind to | | | | | the tcp server | | | | | socket. | | +------------------------------+----------+---------------------+--------------+ -| Failed to load | Server | The server was | [8]_ | +| Failed to load | Server | The server was | [s3]_ | | ssl key | | unable to read and | | | | | process the ssl key.| | +------------------------------+----------+---------------------+--------------+ -| Failed to read file | Server | The server failed | [9]_ | +| Failed to read file | Server | The server failed | [s4]_ | | | | to read the | | | | | specified file | | +------------------------------+----------+---------------------+--------------+ -| Failed to parse file | Server | The server failed | [10]_ | +| Failed to parse file | Server | The server failed | [s5]_ | | | | to parse the | | | | | specified XML file | | +------------------------------+----------+---------------------+--------------+ -| Client metadata resolution | Server | The server cannot | [11]_ | +| Client metadata resolution | Server | The server cannot | [s6]_ | | error for | | resolve the client | | | | | hostname or the | | | | | client is | | | | | associated with a | | | | | non-profile group. | | +------------------------------+----------+---------------------+--------------+ -| Failed to decode | Server | The encoding being | [12]_ | +| Failed to decode | Server | The encoding being | [s7]_ | | Please verify you are using | | used is unable to | | | the proper encoding | | decode the | | | | | character present | | | | | in this file. | | +------------------------------+----------+---------------------+--------------+ -| Got unknown entries | Server | The Packages plugin | [13]_ | +| Got unknown entries | Server | The Packages plugin | [s8]_ | | [list of unknown entries] | | has no knowledge of | | | | | the listed entries | | +------------------------------+----------+---------------------+--------------+ -| Failed to import lxml | Server | The server cannot | [14]_ | +| Failed to import lxml | Server | The server cannot | [s9]_ | | dependency. Shutting | | import lxml | | | down server. | | | | +------------------------------+----------+---------------------+--------------+ -| You need to specify base64 | Server | The server cannot | [15]_ | +| You need to specify base64 | Server | The server cannot | [s10]_ | | encoding for | | send the file as | | | | | ascii text | | +------------------------------+----------+---------------------+--------------+ +| ERROR: Error reading file | Server | The server cannot | [s11]_ | +| '/path/to/schema': failed to | | find the schema | | +| load external entity | | file | | +| "/path/to/schema" | | | | ++------------------------------+----------+---------------------+--------------+ -.. [1] This entry is not being bound. Ensure that a version of this - entry applies to this client. -.. [2] It is possible that the type attribute for this generator entry - is undefined. You may need to add the appropriate type attribute - in the literal entry specification. -.. [3] Copy the Bcfg2 server's CA certificate to the client and specify it - using the **ca** option in the [communication] section of - ``bcfg2.conf`` -.. [4] If the group doesn't exist, you need to specify the correct one - in an :ref:`info.xml ` file or set the default group - appropriately. -.. [5] If the owner doesn't exist, you need to specify the correct one - in an :ref:`info.xml ` file or set the default owner - appropriately. -.. [6] This entry is not being bound. Ensure that a version of this - entry applies to this client. -.. [7] Ensure that another instance of the daemon (or any other process) - is not listening on the same port. -.. [8] Ensure that the key is readable by the user running the daemon - and that it is well-formed. -.. [9] Ensure that this file still exists; a frequent cause is the - deletion of a temp file. -.. [10] Ensure that the file is properly formed XML. -.. [11] Fix hostname resolution for the client or ensure that the profile +.. [s1] This entry is not being bound. Ensure that a version of this + entry applies to this client. +.. [s2] Ensure that another instance of the daemon (or any other process) + is not listening on the same port. +.. [s3] Ensure that the key is readable by the user running the daemon + and that it is well-formed. +.. [s4] Ensure that this file still exists; a frequent cause is the + deletion of a temp file. +.. [s5] Ensure that the file is properly formed XML. +.. [s6] Fix hostname resolution for the client or ensure that the profile group is properly setup. -.. [12] Ensure the correct encoding is specified in the [components] +.. [s7] Ensure the correct encoding is specified in the [components] section of ``bcfg2.conf``. -.. [13] For packages listed other than **gpg-pubkey**, this error means +.. [s8] For packages listed other than **gpg-pubkey**, this error means that the Packages plugin is unable to find the package in any of the sources listed in ``Packages/config.xml``. The issue often arises when the client is not in one of the groups necessary for @@ -203,10 +220,11 @@ be taken to remedy them. ignore the message as the Packages plugin has no knowledge of these packages (however, note that this package is most often specified as a BoundPackage entry). -.. [14] Ensure that you have installed all the necessary +.. [s9] Ensure that you have installed all the necessary :ref:`installation-prerequisites`. -.. [15] You likely need to specify a base64 encoding using an - :ref:`server-info` file for this entry. +.. [s10] You likely need to specify a base64 encoding using an + :ref:`server-info` file for this entry. +.. [s11] Verify that you have the proper prefix set in bcfg2.conf. FAQs ==== -- cgit v1.2.3-1-g7c22