Skip to content

Commit

Permalink
fix: Исправления оформления readme
Browse files Browse the repository at this point in the history
  • Loading branch information
arkuznetsov committed Sep 24, 2019
1 parent 96941fc commit 399cfae
Showing 1 changed file with 33 additions and 17 deletions.
50 changes: 33 additions & 17 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Библиотека управления кластером 1С

[![GitHub release](https://img.shields.io/github/release/ArKuznetsov/irac.svg?style=flat-square)](https://github.com/ArKuznetsov/irac/releases)
[![GitHub license](https://img.shields.io/github/license/ArKuznetsov/irac.svg?style=flat-square)](https://github.com/ArKuznetsov/irac/blob/develop/LICENSE.md)
[![GitHub license](https://img.shields.io/github/license/ArKuznetsov/irac.svg?style=flat-square)](https://github.com/ArKuznetsov/irac/blob/develop/LICENSE)
[![Build Status](https://travis-ci.org/arkuznetsov/irac.svg?branch=develop)](https://travis-ci.org/arkuznetsov/irac)
[![Quality Gate](https://oskk-sonar.1solution.ru/api/badges/gate?key=irac)](https://sonar.silverbulleters.org/dashboard/index/irac)
[![Quality Gate](https://oskk-sonar.1solution.ru/api/badges/gate?key=irac)](oskk-sonar.1solution.ru/dashboard/index/irac)
[![Coverage](https://oskk-sonar.1solution.ru/api/badges/measure?key=irac&metric=coverage)](https://oskk-sonar.1solution.ru/dashboard/index/irac)
[![Tech debt](https://oskk-sonar.1solution.ru/api/badges/measure?key=irac&metric=sqale_debt_ratio)](https://oskk-sonar.1solution.ru/dashboard/index/irac)

## Назначение

Библиотека (oscript) irac предоставляет интерфейс управления кластером серверов 1С:Предприятие 8 с использованием утилиты администрирования кластера (RAC).


## Принцип работы

Библиотека подключается, как отдельный класс и используется для вызова команд утилиты RAC для взаимодействия с одним экземпляром сервера администрирования кластера 1С.
Expand Down Expand Up @@ -57,31 +57,40 @@
КонецЦикла;
```

## Структура основных объектов

АдминистрированиеКластера


```txt
|-Администраторы
|-Кластеры
| |-Администраторы
| |-МенеджерыКластера
| |-Серверы
| | |-ТребованияНазначения
| |-РабочиеПроцессы
| | |-Лицензии
| |-ИнформационныеБазы
| |-Сервисы
| |-Сеансы
| |-Соединения
| | |-Лицензии
| |-Блокировки
| |-ПрофилиБезопасности
|-Администраторы
|-МенеджерыКластера
|-Серверы
| |-ТребованияНазначения
|-РабочиеПроцессы
| |-Лицензии
|-ИнформационныеБазы
|-Сервисы
|-Сеансы
|-Соединения
| |-Лицензии
|-Блокировки
|-ПрофилиБезопасности
|-СчетчикиПотребленияРесурсов
```

## Объекты и методы

### АдминистрированиеКластера

Основной класс библиотеки. Предоставляет интерфейс управления серверами 1С.

```bsl
АдминистрированиеКластера = Новый АдминистрированиеКластера("localhost", 1545, "8.3.10", "admin", "P@ssw0rd");
```

| Параметры конструктора |||
|-|-|-|
| **АдресСервера** |Строка|имя сервера агента администрирования (RAS)|
Expand All @@ -104,11 +113,14 @@
| **ВыводКоманды()** |Массив(Соответствие)|возвращает вывод команды из объекта-исполнитель команд|

### ИсполнительКоманд

Вспомогательный объект для выполнения команд. Непосредственно вызывает утилиту RAC.

```bsl
АдминистрированиеКластера = Новый АдминистрированиеКластера("localhost", 1545, "8.3.10", "admin", "P@ssw0rd");
АдминистрированиеКластера.УстановитьИсполнительКоманд(Новый ИсполнительКоманд("8.3"));
```

| Параметры конструктора |||
|-|-|-|
| **ВерсияИлиПутьКРАК** |Строка|маска версии 1С или путь к утилите RAC|
Expand All @@ -123,15 +135,19 @@
| **КодВозврата()** |Число|возвращает код возврата выполнения команды|

### Кластеры

Объект предоставляет доступ к списку кластеров, доступных для администрирования.

```bsl
АдминистрированиеКластера = Новый АдминистрированиеКластера("localhost", 1545, "8.3.10", "admin", "P@ssw0rd");
СписокКластеров = Новый Кластеры(АдминистрированиеКластера);
```

```bsl
АдминистрированиеКластера = Новый АдминистрированиеКластера("localhost", 1545, "8.3.10", "admin", "P@ssw0rd");
СписокКластеров = АдминистрированиеКластера.Кластеры();
```

| Параметры конструктора |||
|-|-|-|
| **АгентКластера** |АдминистрированиеКластера|ссылка на родительский объект агент кластера|
Expand Down

0 comments on commit 399cfae

Please sign in to comment.