Sureapp - CLI инструмент за управление на уеб приложения

Командата "sureapp" е мощен CLI (command-line interface) инструмент, който позволява създаването и управлението на уеб приложенията във Вашия акаунт. За да използвате "sureapp" инструмента, трябва да се свържете с акаунта си чрез SSH. Можете да откриете информация за установяването на SSH връзка с Вашия акаунт е налична в раздел "SSH" на нашата документация.

Тук са някои от функционалностите, поддържани от инструмента "sureapp":

• Инструкции за употреба
• Създаване на уеб приложение
• Влизане в конзолата на уеб приложение
• Управление на уеб приложение
• Промяна на настройките на уеб приложение
• Промяна на състоянието на уеб приложение
• Управление на променливи на средата на уеб приложение
• Преглеждане на настройките на уеб приложение
• Преглеждане на логовете на уеб приложение
• Изтриване на уеб приложение
• Управление на супервайзора на уеб приложения

Важно: Ако нямате раздел "Уеб приложения" във Вашия Контролен панел, тогава инструкциите в тази статия не са валидни за Вашия акаунт и сървър. Можете да се свържете с нашия екип за повече информация.

Инструкции за употреба

Ако използвате командата "sureapp" без никакви аргументи, ще се покаже списък с нейните подкоманди.

За да видите инструкциите за употреба за определена команда и нейните подкоманди, използвайте следната команда, като не забравяйте да заместите "command" с командата, за която искате да научите повече:

sureapp help command

По-долу можете да откриете списък с наличните команди за "sureapp" CLI инструмента:

• project - позволява Ви да създавате, променяте, изтривате и виждате всички уеб приложения.
• service - дава Ви възможност да виждате и управлявате състоянието на уеб приложения.
• supervisor - позволява Ви да управлявате supervisor услугата.
• meta - показва мета информация.
• log - показва списък с логовете и позволява тяхното преглеждане.
• env - позволява управлението на променливи на средата на уеб приложения.

Ако желаете да видите подкомандите и помощна информация за командата "sureapp project", използвайте командата:

sureapp help project

За да видите инструкции за употреба на командата "sureapp project create", трябва да използвате тази команда:

sureapp help project create

Създаване на уеб приложение

Уеб приложенията могат да се създават през раздел "Уеб приложения" на Контролния панел. По този начин можете да конфигурирате всички задължителни настройки чрез визуален интерфейс. Ако все пак предпочитате да използвате команден ред, можете да използвате "sureapp" CLI инструмента за създаване на уеб приложения и командата "sureapp project create".

За да създадете уеб приложение през командния ред, препоръчваме първо да създадете поддомейн, на който желаете уеб приложението да работи, както и да създадете директория за файловете на приложението. Можете да направите това чрез разделите "Поддомейни" и "Файлове" на Контролния панел. За да видите списък с наличните настройки за командата, можете да я стартирате без никакви аргументи:

sureapp project create

За да създадете уеб приложение чрез инструмента за команден ред "sureapp", задължително трябва да зададете име на уеб приложението и поне следните настройки:

• --engine - позволява да посочите платформата на приложението. Стойността му може да бъде "node" или "custom" (по избор/друга).
• --engine-version - позволява да посочите версията на платформата на приложението. Ако опцията "--engine" е настроена на "custom", тази опция трябва да се настрои на "-" (тире). А ако опцията "--engine" е настроена на "node", тази опция може да се настрои на "current", "lts" или друга от наличните Node.js версии. За да видите списък с всички налични платформи и версии, използвайте командата "sureapp meta engines".
• --release-dir - позволява да посочите директорията, в която ще се намират файловете на уеб приложението. Тази директория трябва да е поддиректория на "~/private" директорията на акаунта Ви и в тази опция трябва да зададете целия път до нея.
• --subdomain - позволява да окажете поддомейна, на който ще бъде достъпно уеб приложението. Поддомейнът няма да се създаде автоматично, ако не съществува. Трябва да създадете поддомейна през раздел "Поддомейни" на Контролния Панел.
• --domain - позволява да окажете домейна, на който ще бъде достъпно уеб приложението. Можете да паркирате домейни към акаунта Ви чрез раздел "Паркирани домейни" на Контролния панел.
• --url-path - позволява Ви да окажете URL пътя, на който ще бъде достъпно уеб приложението. Трябва да изберете пътя без поддомейна и домейна.

В допълнение, можете да използвате и следните опции:

• --notes STR - позволява добавянето на бележки като текст.
• --start-cmd STR - позволява настройването на стартова команда.
• --rlimit-cpu INT - позволява задаване на максимално време за изпълнение на CPU процеси в секунди.
• --rlimit-nproc INT - позволява задаване на максимален брой процеси (и нишки) за уеб приложение.
• --rlimit-core INT - позволява задаване на горен лимит за размера на основните дъмп файлове в байтове.
• --rlimit-data INT - позволява задаване на максималния размер на сегмента от данни за процеса в байтове.
• --rlimit-as INT - позволява задаване на максималния размер на виртуалната памет на процеса в байтове.
• --rlimit-fsize INT - позволява задаване на максималния размер на файловете, създавани от процеса в байтове.
• --rlimit-fileno INT - позволява задаване на максималния брой на отворените файлове от процеса.
• --rlimit-stack INT - позволява задаване на максималния размер на стека на процеса в байтове.

Ако желаете да създадете уеб приложение с име "MyWebApp", което да работи с текущата (current) версия на Node.js на адрес http://www.yourdomain.com/path/to/your/webapp/, чиито файлове да се намират в директорията /home/your_username/private/your_webapp_dir/ directory на акаунта Ви, трябва да използвате командата "sureapp project create", както следва:

sureapp project create --engine node --engine-version current --subdomain www --domain yourdomain.com --release-dir /home/your_username/private/your_webapp_dir/ --url-path /path/to/your/webapp/ MyWebApp

Моля да имате предвид, че е от значение, дали използвате главни или малки букви за всички опции.

Влизане в конзолата на уеб приложение

Можете да влезете в конзолата на уеб приложение с командата "sureapp project shell". Ако желаете да влезете в конзолата на създаденото по-горе приложение с име "MyWebApp", тогава използвайте следната команда:

sureapp project shell MyWebApp

Повечето от командите за управление, налични за употреба с инструмента "sureapp", работят само след като сте влезли в конзолата на уеб приложението.

Управление на уеб приложение

Промяна на настройките на уеб приложение

След като сте влезли в конзолата на уеб приложение, можете да променяте неговите настройки с командата "sureapp project modify". Командата поддържа същите аргументи като командата "sureapp project create", която е описана в раздел "Създаване на уеб приложение" на тази статия.

Например, за да промените платформата на уеб приложението на "custom", трябва да влезете в конзолата на уеб приложението и да използвате тази команда:

sureapp project modify --engine custom --engine-version -

Промяна на състоянието на уеб приложение

Можете да активирате, деактивирате, пускате, спирате, сигнализирате и проверявате статуса на уеб приложение чрез командата "sureapp service". Налични са следните подкоманди:

• status - позволява да се види текущия статус на уеб приложението.
• manage - позволява да се променя статуса на уеб приложението.
• signal - позволява да изпращате сигнали на уеб приложението.

Командата "sureapp service manage" поддържа следните опции:

• --enable - позволява Ви да активирате проекта на уеб приложението.
• --disable - позволява Ви да спрете всички работещи инстанции и да деактивирате проекта на уеб приложението.
• --start - позволява Ви да пуснете уеб приложението, както можете да направите от раздел "Уеб приложения" на Контролния панел.
• --stop - позволява Ви да спрете уеб приложението, както можете да направите от раздел "Уеб приложения" на Контролния панел.
• --once - позволява Ви да пуснете уеб приложението еднократно без рестартиране, ако вече съществува.
• --pause - позволява паузиране на работата на уеб приложението, докато не се възобнови.
• --resume - позволява възобновяване на работата на вече паузирано уеб приложение.

Командата "sureapp service signal" поддържа следните опции за изпращане на сигнали към дървото с процеси на уеб приложението.

• --sigalrm, --SIGALRM - изпращане на сигнал "SIGALRM".
• --sighup, --SIGHUP - изпращане на сигнал "SIGHUP".
• --sigint, --SIGINT - изпращане на сигнал "SIGINT".
• --sigkill, --SIGKILL - изпращане на сигнал "SIGKILL".
• --sigquit, --SIGQUIT - изпращане на сигнал "SIGQUIT".
• --sigterm, --SIGTERM - изпращане на сигнал "SIGTERM".
• --sigwinch, --SIGWINCH - изпращане на сигнал "SIGWINCH".
• --sigusr1, --SIGUSR1 - изпращане на сигнал "SIGUSR1".
• --sigusr2, --SIGUSR2 - изпращане на сигнал "SIGUSR2".

Ако желаете да активирате уеб приложение, можете да влезете в неговата конзола и да изпълните тази команда:

sureapp service manage --enable

Управление на променливи на средата на уеб приложение

След като сте влезли в конзолата на уеб приложение, можете да управлявате променливите за неговата среда чрез командата "sureapp env". Тази команда има няколко подкоманди:

• set - позволява да настройвате променливи за уеб приложението.
• unset - позволява да премахвате настроени променливи за уеб приложението.
• list - показва списък с всички променливи за средата на уеб приложението.

Можете да използвате следната команда, след като сте достъпили конзолата на уеб приложение, ако желаете да настроите нова променлива за неговата среда с име "VAR1" и стойност "NEWVALUE":

sureapp env set VAR1 NEWVALUE

Преглеждане на настройките на уеб приложение

Можете да видите настройките на уеб приложение в лесен за обработка от машини формат чрез командата "sureapp meta config". Командата има няколко опции, които определят в какъв формат да получите настройките на уеб приложението:

• --json - предоставя настройките на уеб приложението в (pretty printed) JSON формат.
• --perl - предоставя настройките на уеб приложението в Perl Data::Dumper формат.
• --yaml - предоставя настройките на уеб приложението в YAML формат.

За да получите настройките на уеб приложение в YAML формат, влезте в конзолата на уеб приложението и използвайте следната команда:

sureapp meta config --yaml

Преглеждане на логовете на уеб приложение

Инструментът "sureapp" Ви позволява и да преглеждате или следите логовете на уеб приложения в реално време с командата "sureapp log". Тази команда има следните подкоманди:

• list - показва списък с логовете за проекта.
• view - показва съдържанието на определен лог файл.
• follow - позволява да наблюдавате (tail) лог файл в реално време

Ако желаете да следите лог файл за уеб приложение в реално време, използвайте следната команда, след като сте влезли в конзолата на уеб приложението:

sureapp log follow

Изтриване на уеб приложение

Уеб приложенията могат да се изтриват през раздел "Уеб приложения" на Контролния панел, но това може да бъде извършено и чрез командата "sureapp project remove" на CLI инструмента "sureapp".

За да изтриете уеб приложение, трябва да въведете само неговото име. Например за изтриване на уеб приложение с име "MyWebApp" трябва да използвате тази команда:

sureapp project remove MyWebApp

Управление на супервайзъра на уеб приложения

Супервайзърът на уеб приложения е системен процес, който поддържа уеб приложенията в работещо състояние. Супервайзърът на уеб приложение може да пуска, спира или рестартира уеб приложения, когато това е необходимо. Той също така поддържа процесите, стартирани от уеб приложенията. Можете да го управлявате с командата "sureapp supervisor", която има следните подкоманди:

• start - позволява да пуснете супервайзър процеса.
• stop - позволява да спрете супервайзър процеса.
• restart - позволява да рестартирате супервайзър процеса.
• status - позволява да проверите статуса на супервайзър процеса.
• tree - позволява да видите дървото с подпроцеси на супервайзър процеса.

Можете да използвате следната команда, за да видите статуса на супервайзър процеса (напр. дали той работи):

sureapp supervisor status