Skip to content

Commit 0274565

Browse files
authored
Merge pull request #1 from Netcracker/fix/doc_fixes
Fix to replace specifics in documentation
2 parents d1357dd + 1e431f5 commit 0274565

File tree

53 files changed

+30
-9803
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+30
-9803
lines changed

Dockerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
FROM library/rabbitmq:4.0.7-management-alpine
22

33
COPY docker-entrypoint.sh /usr/local/bin/
4-
COPY /openshift/scripts/get_user /bin/
5-
COPY /openshift/scripts/get_password /bin/
6-
COPY /openshift/scripts/change_password /bin/
4+
COPY scripts/get_user /bin/
5+
COPY scripts/get_password /bin/
6+
COPY scripts/change_password /bin/
77

88
ENV USER_UID=1000
99

README.md

Lines changed: 6 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
# RabbitMQ Service
44

5+
## Documentation
6+
* [Architecture guide](https://github.com/Netcracker/qubership-rabbitmq/blob/fix/doc_fixes/docs/public/architecture.md)
7+
* [Installation guide](https://github.com/Netcracker/qubership-rabbitmq/blob/main/docs/public/installation.md)
8+
* [Monitoring guide](https://github.com/Netcracker/qubership-rabbitmq/blob/fix/doc_fixes/docs/public/monitoring.md)
9+
* [Troubleshooting guide](https://github.com/Netcracker/qubership-rabbitmq/blob/fix/doc_fixes/docs/public/troubleshooting.md)
10+
511
## Repository structure
612

713
* `./docs` - directory with actual documentation for the component.
@@ -31,30 +37,6 @@
3137
helm install rabbitmq ./ -f sample.yaml -n <TARGET_NAMESPACE>
3238
```
3339

34-
#### Application deployer
35-
36-
1. Build a manifest using [Manifest building guide](#manifest).
37-
2. Prepare Cloud Deploy Configuration:
38-
1. Go to the [APP-Deployer infrastructure configuration](https://cloud-deployer.qubership.org/job/INFRA/job/groovy.deploy.v3/).
39-
2. INFRA --> Clouds --> find your cloud --> Namespaces --> find your namespace.
40-
3. If the namespace is **not presented** then:
41-
1. Click `Create` button and specify: namespace and credentials.
42-
2. Click `Save`.
43-
3. Go to your namespace configuration and specify the parameters for service installing.
44-
4. If the namespace is presented then: just check the parameters or change them.
45-
3. To deploy service using APP-Deployer:
46-
1. Go to the [APP-Deployer groovy deploy page](https://cloud-deployer.qubership.org/job/INFRA/job/groovy.deploy.v3/).
47-
2. Go to the `Build with Parameters` tab.
48-
3. Specify:
49-
1. Project: it is your cloud and namespace.
50-
2. The list is based on the information from the [APP-Deployer infrastructure configuration](https://cloud-deployer.qubership.org/job/INFRA/job/groovy.deploy.v3/).
51-
3. Deploy mode - `Rolling Update`.
52-
4. Artifact descriptor version --> the **application manifest**.
53-
54-
#### ArgoCD
55-
56-
The information about ArgoCD deployment can be found in [Platform ArgoCD guide](https://bass.qubership.org/display/PLAT/ArgoCD+guide).
57-
5840
### Smoke tests
5941

6042
There is no smoke tests.
@@ -72,48 +54,10 @@ There are no well-defined rules for troubleshooting, as each task is unique, but
7254
* Logs from all RabbitMQ service pods.
7355

7456
Also, developer can take a look on [Troubleshooting guide](/docs/public/troubleshooting.md).
75-
76-
#### APP-Deployer job typical errors
77-
78-
##### Application does not exist in the CMDB
79-
80-
The error like "ERROR: Application does not exist in the CMDB" means that the APP-Deployer doesn't have
81-
configuration related to the "service-name" from application manifest.
82-
83-
**Solution**: check that the correct manifest is used.
84-
85-
##### CUSTOM_RESOURCE timeout
86-
87-
The error like "CUSTOM_RESOURCE timeout" means the service was deployed to the namespace, but the Custom Resource doesn't have SUCCESS status.
88-
Usually, it is related to the service state - it might be unhealthy or repeatedly crushing.
89-
90-
**Solution**: there is no ready answer, need to go to namespace & check service state, operator logs to find a root cause and fix it.
91-
92-
## CI/CD
93-
94-
The main CI/CD pipeline is design to automize all basic developer routine start from code quality and finish with
95-
deploying to stand k8s cluster.
96-
97-
1. `linter` - stage with jobs that run different linter to check code & documentation.
98-
2. `build` - stage with jobs that build docker images for RabbitMQ components using DP-Builder.
99-
3. `manifest` - stage with jobs that build manifest for current branch or release manifest using DP-Builder.
100-
4. `cloudDeploy` - optional stage with job which deploys the manifest to `ci-master`, `miniha`, `k8s1/2` clusters using APP-Deployer.
101-
5. `cloudDeployTests` - stage with job which deploys manifest with integration tests using APP-Deployer.
102-
6. `manifestValidation` - optional stage with jobs that validate manifest (check is it ready to be released) and check
103-
vulnerabilities.
104-
10557
## Evergreen strategy
10658

10759
To keep the component up to date, the following activities should be performed regularly:
10860

10961
* Vulnerabilities fixing.
11062
* RabbitMQ upgrade.
11163
* Bug-fixing, improvement and feature implementation in operator, monitoring or other RabbitMQ components.
112-
113-
## Useful links
114-
115-
* [Installation guide](/docs/public/installation.md).
116-
* [Troubleshooting guide](/docs/public/troubleshooting.md).
117-
* [Internal Developer Guide](/docs/internal/developing.md).
118-
* [Cloud INFRA Development process](https://bass.qubership.org/display/PLAT/Cloud+Infra+Platform+services%3A+development+process).
119-
* [ArgoCD User guide](https://bass.qubership.org/display/PLAT/ArgoCD+guide)

docs/data/capabilities.yaml

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,7 @@ Installation:
2424
- Kubernetes
2525
- Openshift
2626
FullyAutomated: yes
27-
AppDeployer:
28-
Supported: yes
29-
Environment:
30-
- Kubernetes
31-
- Openshift
32-
FullyAutomated: yes
27+
3328
Ansible:
3429
Supported: yes
3530
Environment:
@@ -43,13 +38,7 @@ Upgrade:
4338
- Openshift
4439
FullyAutomated: yes
4540
Downtime: no
46-
AppDeployer:
47-
Supported: yes
48-
Environment:
49-
- Kubernetes
50-
- Openshift
51-
FullyAutomated: yes
52-
Downtime: no
41+
5342
Ansible:
5443
Supported: yes
5544
Environment:

docs/internal/developing.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/internal/examples/qatested_AppDeployer_k8s_storageclass_DRD_TLS.yaml

Lines changed: 0 additions & 66 deletions
This file was deleted.

docs/internal/examples/qatested_deployment_via_AppDeployer_on_OpenShift_for_storageclass.yaml

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/internal/examples/qatested_deployment_via_AppDeployer_on_kubernetes_for_PV.yaml

Lines changed: 0 additions & 65 deletions
This file was deleted.

docs/internal/examples/qatested_deployment_via_AppDeployer_on_kubernetes_for_storageclass.yaml

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/internal/examples/qatested_deployment_via_DPdeployer_on_OpenShift_for_storageclass.yaml

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)