From be74f1fd4ad8f76540b1b34b9382050826d93372 Mon Sep 17 00:00:00 2001 From: Serghey Rodin Date: Wed, 28 Dec 2011 14:26:02 +0200 Subject: [PATCH] Added documentation for DNS --- bin/v_add_dns_domain | 10 +++++++++- bin/v_add_dns_domain_record | 9 ++++++++- bin/v_change_dns_domain_exp | 7 ++++++- bin/v_change_dns_domain_ip | 6 +++++- bin/v_change_dns_domain_record | 6 +++++- bin/v_change_dns_domain_soa | 7 ++++++- bin/v_change_dns_domain_tpl | 8 +++++++- bin/v_change_dns_domain_ttl | 6 +++++- bin/v_delete_dns_domain | 7 ++++++- bin/v_delete_dns_domain_record | 6 +++++- bin/v_delete_dns_domains | 6 +++++- bin/v_get_dns_domain_value | 6 +++++- bin/v_list_dns_domain | 6 +++++- bin/v_list_dns_domains | 6 +++++- bin/v_list_dns_template | 6 +++++- bin/v_list_dns_templates | 6 +++++- bin/v_rebuild_dns_domains | 6 +++++- bin/v_restart_dns | 28 ++++++++++++++++++++-------- bin/v_suspend_dns_domain | 6 +++++- bin/v_suspend_dns_domains | 6 +++++- bin/v_unsuspend_dns_domain | 6 +++++- bin/v_unsuspend_dns_domains | 6 +++++- 22 files changed, 137 insertions(+), 29 deletions(-) diff --git a/bin/v_add_dns_domain b/bin/v_add_dns_domain index 31a2b3215..8e65eaa9f 100755 --- a/bin/v_add_dns_domain +++ b/bin/v_add_dns_domain @@ -1,5 +1,13 @@ #!/bin/bash -# info: adding dns domain +# info: add dns domain +# arguments: user domain ip [template] [exp] [soa] [ttl] +# +# The function adds DNS zone with records defined in the template. If the exp +# argument isn't stated, the expiration date value will be set to next year. +# The soa argument is responsible for the relevant record. By default the first +# user's NS server is used. TTL is set as common for the zone and for all of +# its records with a default value of 14400 seconds. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_add_dns_domain_record b/bin/v_add_dns_domain_record index 8f9e13cdb..542ad5ff5 100755 --- a/bin/v_add_dns_domain_record +++ b/bin/v_add_dns_domain_record @@ -1,5 +1,12 @@ #!/bin/bash -# info: adding dns domain record +# info: add dns domain record +# arguments: user domain record type value [id] +# +# The call is used for adding new DNS record. Complex records of TXT, MX and +# SRV types can be used by a filling in the 'value' argument. The function also +# gets an id parameter for definition of certain record identifier or for the +# regulation of records. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_change_dns_domain_exp b/bin/v_change_dns_domain_exp index 800152042..273b7fe06 100755 --- a/bin/v_change_dns_domain_exp +++ b/bin/v_change_dns_domain_exp @@ -1,5 +1,10 @@ #!/bin/bash -# info: changing dns domain exp date +# info: change dns domain expiriation date +# arguments: user domain exp +# +# The function of changing the term of expiration domain's registration. The +# serial number will be refreshed automatically during update. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_change_dns_domain_ip b/bin/v_change_dns_domain_ip index 3805012e0..3ceb8eacc 100755 --- a/bin/v_change_dns_domain_ip +++ b/bin/v_change_dns_domain_ip @@ -1,5 +1,9 @@ #!/bin/bash -# info: changing dns domain ip +# info: change dns domain ip address +# arguments: user domain ip +# +# The function for changing the main ip of DNS zone. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_change_dns_domain_record b/bin/v_change_dns_domain_record index ed9fe8d50..58a6e6683 100755 --- a/bin/v_change_dns_domain_record +++ b/bin/v_change_dns_domain_record @@ -1,5 +1,9 @@ #!/bin/bash -# info: changing dns domain record +# info: change dns domain record +# arguments: user domain id record type value +# +# The function for changing DNS record. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_change_dns_domain_soa b/bin/v_change_dns_domain_soa index 4d7f7e94c..ec9784825 100755 --- a/bin/v_change_dns_domain_soa +++ b/bin/v_change_dns_domain_soa @@ -1,5 +1,10 @@ #!/bin/bash -# info: changing dns domain soa +# info: change dns domain soa record +# arguments: user domain soa +# +# The function for changing SOA record. This type of records can not be +# modified by v_change_dns_domain_record call. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_change_dns_domain_tpl b/bin/v_change_dns_domain_tpl index 6fef6b12b..2ed4c6f71 100755 --- a/bin/v_change_dns_domain_tpl +++ b/bin/v_change_dns_domain_tpl @@ -1,5 +1,11 @@ #!/bin/bash -# info: changing dns domain template +# info: change dns domain template +# arguments: user domain +# +# The function for changing the template of records. By updating old records +# will be removed and new records will be generated in accordance with +# parameters of new template. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_change_dns_domain_ttl b/bin/v_change_dns_domain_ttl index 6725d06be..7af316151 100755 --- a/bin/v_change_dns_domain_ttl +++ b/bin/v_change_dns_domain_ttl @@ -1,5 +1,9 @@ #!/bin/bash -# info: changing dns domain ttl +# info: change dns domain ttl +# arguments: user domain ttl +# +# The function for chaning the time to live TTL parameter for all records. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_delete_dns_domain b/bin/v_delete_dns_domain index fb8540538..232c93710 100755 --- a/bin/v_delete_dns_domain +++ b/bin/v_delete_dns_domain @@ -1,5 +1,10 @@ #!/bin/bash -# info: deliting dns domain +# info: delite dns domain +# arguments: user domain +# +# The function for deleting DNS domain. By deleting it all records will also be +# deleted. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_delete_dns_domain_record b/bin/v_delete_dns_domain_record index 68162f504..aa37c2c9b 100755 --- a/bin/v_delete_dns_domain_record +++ b/bin/v_delete_dns_domain_record @@ -1,5 +1,9 @@ #!/bin/bash -# info: deleting dns record +# info: delete dns record +# arguments: user domain id +# +# The function for deleting a certain record of DNS zone. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_delete_dns_domains b/bin/v_delete_dns_domains index 634664e24..2351c8ba8 100755 --- a/bin/v_delete_dns_domains +++ b/bin/v_delete_dns_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: deleteing all user dns domains +# info: delete dns domains +# arguments: user +# +# The function for deleting all users DNS domains. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_get_dns_domain_value b/bin/v_get_dns_domain_value index 43ab2095c..b776b13a1 100755 --- a/bin/v_get_dns_domain_value +++ b/bin/v_get_dns_domain_value @@ -1,5 +1,9 @@ #!/bin/bash -# info: Getting dns domain value +# info: get dns domain value +# arguments: user domain key +# +# The function for getting a certain DNS domain parameter. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_list_dns_domain b/bin/v_list_dns_domain index 94293bece..72b5fee87 100755 --- a/bin/v_list_dns_domain +++ b/bin/v_list_dns_domain @@ -1,5 +1,9 @@ #!/bin/bash -# info: listing dns domain +# info: list dns domain +# arguments: user domain [format] +# +# The function for getting all DNS domain's parameters. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_list_dns_domains b/bin/v_list_dns_domains index 925978562..7a76d0bc7 100755 --- a/bin/v_list_dns_domains +++ b/bin/v_list_dns_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: listing dns domains +# info: list dns domains +# arguments: user [format] +# +# The function for obtaining all DNS domains of a user. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_list_dns_template b/bin/v_list_dns_template index 2cec9c652..1654c7b57 100755 --- a/bin/v_list_dns_template +++ b/bin/v_list_dns_template @@ -1,5 +1,9 @@ #!/bin/bash -# info: listing dns template +# info: list dns template +# arguments: template [format] +# +# The function for obtaining the DNS template parameters. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_list_dns_templates b/bin/v_list_dns_templates index fa348b2dd..bdfecd29a 100755 --- a/bin/v_list_dns_templates +++ b/bin/v_list_dns_templates @@ -1,5 +1,9 @@ #!/bin/bash -# info: listing dns templates +# info: list dns templates +# arguments: [format] +# +# The function for obtaining the list of all DNS templates available. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_rebuild_dns_domains b/bin/v_rebuild_dns_domains index e0064f0be..37f0724e4 100755 --- a/bin/v_rebuild_dns_domains +++ b/bin/v_rebuild_dns_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: rebuilding dns domains +# info: rebuild dns domains +# arguments: user +# +# The function rebuilds BIND configuration files for all dns domains. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_restart_dns b/bin/v_restart_dns index d583eb2c0..a5c8540d2 100755 --- a/bin/v_restart_dns +++ b/bin/v_restart_dns @@ -1,22 +1,34 @@ #!/bin/bash -# Internal vesta function -# dns system restart +# info: restart dns service +# arguments: none +# +# The function tells BIND service to reload dns zone files. + + +#----------------------------------------------------------# +# Variable&Function # +#----------------------------------------------------------# # Importing variables source /etc/profile.d/vesta.sh source $VESTA/conf/vesta.conf -bind() { + +#----------------------------------------------------------# +# Action # +#----------------------------------------------------------# + +if [ "$DNS_SYSTEM" = 'bind' ]; then /etc/init.d/named reload >/dev/null 2>&1 if [ $? -ne 0 ]; then #$V_FUNC/report_issue 'sys' 'cron' echo "$E_RESTART_FAILED $V_EVENT" fi -} - - -if [ "$DNS_SYSTEM" = 'bind' ]; then - bind fi + +#----------------------------------------------------------# +# Vesta # +#----------------------------------------------------------# + exit diff --git a/bin/v_suspend_dns_domain b/bin/v_suspend_dns_domain index 0a8d4003d..ed6022518 100755 --- a/bin/v_suspend_dns_domain +++ b/bin/v_suspend_dns_domain @@ -1,5 +1,9 @@ #!/bin/bash -# info: suspening dns domain +# info: suspend dns domain +# arguments: user domain +# +# The function suspends a certain user's domain. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_suspend_dns_domains b/bin/v_suspend_dns_domains index 2ad6f05c2..d5c109e10 100755 --- a/bin/v_suspend_dns_domains +++ b/bin/v_suspend_dns_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: suspening dns domains +# info: suspend dns domains +# arguments: user +# +# The function suspends all user's DNS domains. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_unsuspend_dns_domain b/bin/v_unsuspend_dns_domain index 351e6ed49..0676cd2e8 100755 --- a/bin/v_unsuspend_dns_domain +++ b/bin/v_unsuspend_dns_domain @@ -1,5 +1,9 @@ #!/bin/bash -# info: unsuspening dns domain +# info: unsuspend dns domain +# arguments: user domain +# +# The function unsuspends a certain user's domain. + #----------------------------------------------------------# # Variable&Function # diff --git a/bin/v_unsuspend_dns_domains b/bin/v_unsuspend_dns_domains index f862d9788..41d9049b0 100755 --- a/bin/v_unsuspend_dns_domains +++ b/bin/v_unsuspend_dns_domains @@ -1,5 +1,9 @@ #!/bin/bash -# info: unsuspening dns domains +# info: unsuspend dns domains +# arguments: user +# +# The function unsuspends all user's DNS domains. + #----------------------------------------------------------# # Variable&Function #